user

package
v1.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 28, 2020 License: MIT Imports: 44 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// AccessTokenErrorCodeInvalidRequest represents an error code specified in RFC 6749
	AccessTokenErrorCodeInvalidRequest AccessTokenErrorCode = "invalid_request"
	// AccessTokenErrorCodeInvalidClient represents an error code specified in RFC 6749
	AccessTokenErrorCodeInvalidClient = "invalid_client"
	// AccessTokenErrorCodeInvalidGrant represents an error code specified in RFC 6749
	AccessTokenErrorCodeInvalidGrant = "invalid_grant"
	// AccessTokenErrorCodeUnauthorizedClient represents an error code specified in RFC 6749
	AccessTokenErrorCodeUnauthorizedClient = "unauthorized_client"
	// AccessTokenErrorCodeUnsupportedGrantType represents an error code specified in RFC 6749
	AccessTokenErrorCodeUnsupportedGrantType = "unsupported_grant_type"
	// AccessTokenErrorCodeInvalidScope represents an error code specified in RFC 6749
	AccessTokenErrorCodeInvalidScope = "invalid_scope"
)
View Source 
const (

	// TplActivate template path for activate user
	TplActivate base.TplName = "user/auth/activate"
)

Variables

This section is empty.

Functions

func AccessTokenOAuth added in v1.8.0 

func AccessTokenOAuth(ctx *context.Context, form auth.AccessTokenForm)

AccessTokenOAuth manages all access token requests by the client

func Action 

func Action(ctx *context.Context)

Action response for follow/unfollow user request

func Activate 

func Activate(ctx *context.Context)

Activate render activate user page

func ActivateEmail 

func ActivateEmail(ctx *context.Context)

ActivateEmail render the activate email page

func AuthorizeOAuth added in v1.8.0 

func AuthorizeOAuth(ctx *context.Context, form auth.AuthorizationForm)

AuthorizeOAuth manages authorize requests

func AutoSignIn 

func AutoSignIn(ctx *context.Context) (bool, error)

AutoSignIn reads cookie and try to auto-login.

func Avatar added in v1.10.0 

func Avatar(ctx *context.Context)

Avatar redirect browser to user avatar of requested size

func AvatarByEmailHash added in v1.12.0 

func AvatarByEmailHash(ctx *context.Context)

AvatarByEmailHash redirects the browser to the appropriate Avatar link

func ConnectOpenID added in v1.2.0 

func ConnectOpenID(ctx *context.Context)

ConnectOpenID shows a form to connect an OpenID URI to an existing account

func ConnectOpenIDPost added in v1.2.0 

func ConnectOpenIDPost(ctx *context.Context, form auth.ConnectOpenIDForm)

ConnectOpenIDPost handles submission of a form to connect an OpenID URI to an existing account

func Dashboard 

func Dashboard(ctx *context.Context)

Dashboard render the dashboard page

func Email2User 

func Email2User(ctx *context.Context)

Email2User show user page via email

func ForgotPasswd 

func ForgotPasswd(ctx *context.Context)

ForgotPasswd render the forget pasword page

func ForgotPasswdPost 

func ForgotPasswdPost(ctx *context.Context)

ForgotPasswdPost response for forget password request

func GetNotificationCount added in v1.1.0 

func GetNotificationCount(c *context.Context)

GetNotificationCount is the middleware that sets the notification count in the context

func GetUserByName 

func GetUserByName(ctx *context.Context, name string) *models.User

GetUserByName get user by name

func GetUserByParams 

func GetUserByParams(ctx *context.Context) *models.User

GetUserByParams returns user whose name is presented in URL paramenter.

func GrantApplicationOAuth added in v1.8.0 

func GrantApplicationOAuth(ctx *context.Context, form auth.GrantApplicationForm)

GrantApplicationOAuth manages the post request submitted when a user grants access to an application

func HandleSignOut added in v1.12.0 

func HandleSignOut(ctx *context.Context)

HandleSignOut resets the session and sets the cookies

func Issues 

func Issues(ctx *context.Context)

Issues render the user issues page

func LinkAccount added in v1.1.0 

func LinkAccount(ctx *context.Context)

LinkAccount shows the page where the user can decide to login or create a new account

func LinkAccountPostRegister added in v1.1.0 

func LinkAccountPostRegister(ctx *context.Context, cpt *captcha.Captcha, form auth.RegisterForm)

LinkAccountPostRegister handle the creation of a new account for an external account using signUp

func LinkAccountPostSignIn added in v1.1.0 

func LinkAccountPostSignIn(ctx *context.Context, signInForm auth.SignInForm)

LinkAccountPostSignIn handle the coupling of external account with another account using signIn

func Milestones added in v1.11.0 

func Milestones(ctx *context.Context)

Milestones render the user milestones page

func MustChangePassword added in v1.6.0 

func MustChangePassword(ctx *context.Context)

MustChangePassword renders the page to change a user's password

func MustChangePasswordPost added in v1.6.0 

func MustChangePasswordPost(ctx *context.Context, cpt *captcha.Captcha, form auth.MustChangePasswordForm)

MustChangePasswordPost response for updating a user's password after his/her account was created by an admin

func NotificationPurgePost added in v1.4.0 

func NotificationPurgePost(c *context.Context)

NotificationPurgePost is a route for 'purging' the list of notifications - marking all unread as read

func NotificationStatusPost added in v1.1.0 

func NotificationStatusPost(c *context.Context)

NotificationStatusPost is a route for changing the status of a notification

func Notifications added in v1.1.0 

func Notifications(c *context.Context)

Notifications is the notifications page

func Profile 

func Profile(ctx *context.Context)

Profile render user's profile page

func RegisterOpenID added in v1.2.0 

func RegisterOpenID(ctx *context.Context)

RegisterOpenID shows a form to create a new user authenticated via an OpenID URI

func RegisterOpenIDPost added in v1.2.0 

func RegisterOpenIDPost(ctx *context.Context, cpt *captcha.Captcha, form auth.SignUpOpenIDForm)

RegisterOpenIDPost handles submission of a form to create a new user authenticated via an OpenID URI

func ResetPasswd 

func ResetPasswd(ctx *context.Context)

ResetPasswd render the account recovery page

func ResetPasswdPost 

func ResetPasswdPost(ctx *context.Context)

ResetPasswdPost response from account recovery request

func ShowGPGKeys added in v1.9.0 

func ShowGPGKeys(ctx *context.Context, uid int64)

ShowGPGKeys output all the public GPG keys of user by uid

func ShowSSHKeys 

func ShowSSHKeys(ctx *context.Context, uid int64)

ShowSSHKeys output all the ssh keys of user by uid

func SignIn 

func SignIn(ctx *context.Context)

SignIn render sign in page

func SignInOAuth added in v1.1.0 

func SignInOAuth(ctx *context.Context)

SignInOAuth handles the OAuth2 login buttons

func SignInOAuthCallback added in v1.1.0 

func SignInOAuthCallback(ctx *context.Context)

SignInOAuthCallback handles the callback from the given provider

func SignInOpenID added in v1.2.0 

func SignInOpenID(ctx *context.Context)

SignInOpenID render sign in page

func SignInOpenIDPost added in v1.2.0 

func SignInOpenIDPost(ctx *context.Context, form auth.SignInOpenIDForm)

SignInOpenIDPost response for openid sign in request

func SignInPost 

func SignInPost(ctx *context.Context, form auth.SignInForm)

SignInPost response for sign in request

func SignOut 

func SignOut(ctx *context.Context)

SignOut sign out from login status

func SignUp 

func SignUp(ctx *context.Context)

SignUp render the register page

func SignUpPost 

func SignUpPost(ctx *context.Context, cpt *captcha.Captcha, form auth.RegisterForm)

SignUpPost response for sign up information submission

func TaskStatus added in v1.13.0 

func TaskStatus(ctx *context.Context)

TaskStatus returns task's status

func TwoFactor added in v1.1.0 

func TwoFactor(ctx *context.Context)

TwoFactor shows the user a two-factor authentication page.

func TwoFactorPost added in v1.1.0 

func TwoFactorPost(ctx *context.Context, form auth.TwoFactorAuthForm)

TwoFactorPost validates a user's two-factor authentication token.

func TwoFactorScratch added in v1.1.0 

func TwoFactorScratch(ctx *context.Context)

TwoFactorScratch shows the scratch code form for two-factor authentication.

func TwoFactorScratchPost added in v1.1.0 

func TwoFactorScratchPost(ctx *context.Context, form auth.TwoFactorScratchAuthForm)

TwoFactorScratchPost validates and invalidates a user's two-factor scratch token.

func U2F added in v1.5.0 

func U2F(ctx *context.Context)

U2F shows the U2F login page

func U2FChallenge added in v1.5.0 

func U2FChallenge(ctx *context.Context)

U2FChallenge submits a sign challenge to the browser

func U2FSign added in v1.5.0 

func U2FSign(ctx *context.Context, signResp u2f.SignResponse)

U2FSign authenticates the user by signResp

Types

type AccessTokenError added in v1.8.0 

type AccessTokenError struct {
	ErrorCode        AccessTokenErrorCode `json:"error" form:"error"`
	ErrorDescription string               `json:"error_description"`
}

AccessTokenError represents an error response specified in RFC 6749

func (AccessTokenError) Error added in v1.8.0 

func (err AccessTokenError) Error() string

Error returns the error message

type AccessTokenErrorCode added in v1.8.0 

type AccessTokenErrorCode string

AccessTokenErrorCode represents an error code specified in RFC 6749

type AccessTokenResponse added in v1.8.0 

type AccessTokenResponse struct {
	AccessToken  string    `json:"access_token"`
	TokenType    TokenType `json:"token_type"`
	ExpiresIn    int64     `json:"expires_in"`
	RefreshToken string    `json:"refresh_token"`
}

AccessTokenResponse represents a successful access token response

type AuthorizeError added in v1.8.0 

type AuthorizeError struct {
	ErrorCode        AuthorizeErrorCode `json:"error" form:"error"`
	ErrorDescription string
	State            string
}

AuthorizeError represents an error type specified in RFC 6749

func (AuthorizeError) Error added in v1.8.0 

func (err AuthorizeError) Error() string

Error returns the error message

type AuthorizeErrorCode added in v1.8.0 

type AuthorizeErrorCode string

AuthorizeErrorCode represents an error code specified in RFC 6749 

const (
	// ErrorCodeInvalidRequest represents the according error in RFC 6749
	ErrorCodeInvalidRequest AuthorizeErrorCode = "invalid_request"
	// ErrorCodeUnauthorizedClient represents the according error in RFC 6749
	ErrorCodeUnauthorizedClient AuthorizeErrorCode = "unauthorized_client"
	// ErrorCodeAccessDenied represents the according error in RFC 6749
	ErrorCodeAccessDenied AuthorizeErrorCode = "access_denied"
	// ErrorCodeUnsupportedResponseType represents the according error in RFC 6749
	ErrorCodeUnsupportedResponseType AuthorizeErrorCode = "unsupported_response_type"
	// ErrorCodeInvalidScope represents the according error in RFC 6749
	ErrorCodeInvalidScope AuthorizeErrorCode = "invalid_scope"
	// ErrorCodeServerError represents the according error in RFC 6749
	ErrorCodeServerError AuthorizeErrorCode = "server_error"
	// ErrorCodeTemporaryUnavailable represents the according error in RFC 6749
	ErrorCodeTemporaryUnavailable AuthorizeErrorCode = "temporarily_unavailable"
)

type TokenType added in v1.8.0 

type TokenType string

TokenType specifies the kind of token 

const (
	// TokenTypeBearer represents a token type specified in RFC 6749
	TokenTypeBearer TokenType = "bearer"
	// TokenTypeMAC represents a token type specified in RFC 6749
	TokenTypeMAC = "mac"
)

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.