authentication

package
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Apr 25, 2023 License: MIT Imports: 18 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAccessToken 

func GetAccessToken(client *Client) (string, error)

GetAccessToken 获取访问Token

func QueryAccessToken 

func QueryAccessToken(client *Client) (*model.AccessTokenRes, error)

TODO

Types

type Client 

type Client struct {
	HttpClient              *http.Client
	AppId                   string
	Protocol                constant.ProtocolEnum
	Secret                  string
	Host                    string
	RedirectUri             string
	UserPoolId              string
	TokenEndPointAuthMethod constant.AuthMethodEnum

	ClientToken *string
	ClientUser  *model.User

	Log func(s string)
}

func NewClient 

func NewClient(appId string, secret string, host ...string) *Client

func (*Client) AssociateFaceByUrl 

func (c *Client) AssociateFaceByUrl(baseFaceUrl, CompareFaceUrl, token string) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

AssociateFaceByUrl 通过图片 URL 绑定人脸

func (*Client) AssociateMfaAuthenticator 

func (c *Client) AssociateMfaAuthenticator(req *model.MfaInput) (*struct {
	Message string                                  `json:"message"`
	Code    int64                                   `json:"code"`
	Data    model.AssociateMfaAuthenticatorResponse `json:"data"`
}, error)

AssociateMfaAuthenticator 请求 MFA 二维码和密钥信息

func (*Client) BindEmail 

func (c *Client) BindEmail(email, emailCode string) (*model.User, error)

BindEmail 绑定邮箱号

func (*Client) BindPhone 

func (c *Client) BindPhone(phone, phoneCode string) (*model.User, error)

BindPhone 绑定手机号

func (*Client) BuildAuthorizeUrlByCas 

func (c *Client) BuildAuthorizeUrlByCas(service *string) string

func (*Client) BuildAuthorizeUrlByOauth 

func (c *Client) BuildAuthorizeUrlByOauth(scope, redirectUri, state, responseType string) (string, error)

func (*Client) BuildAuthorizeUrlByOidc 

func (c *Client) BuildAuthorizeUrlByOidc(params model.OidcParams) (string, error)

TODO

func (*Client) BuildAuthorizeUrlBySaml 

func (c *Client) BuildAuthorizeUrlBySaml() string

func (*Client) BuildLogoutUrl 

func (c *Client) BuildLogoutUrl(expert, redirectUri, idToken *string) string

BuildLogoutUrl 拼接登出 URL

func (*Client) CheckLoginStatus 

func (c *Client) CheckLoginStatus(token string) (*model.CheckLoginStatusResponse, error)

CheckLoginStatus 检测 Token 登录状态

func (*Client) CheckPasswordStrength 

func (c *Client) CheckPasswordStrength(password string) (*struct {
	Valid   bool   `json:"valid"`
	Message string `json:"message"`
}, error)

CheckPasswordStrength 检查密码强度

func (*Client) ClearUser 

func (c *Client) ClearUser()

func (*Client) ConfirmAssociateMfaAuthenticator 

func (c *Client) ConfirmAssociateMfaAuthenticator(req *model.ConfirmAssociateMfaAuthenticatorRequest) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

ConfirmAssociateMfaAuthenticator 确认绑定 MFA

func (*Client) DeleteMfaAuthenticator 

func (c *Client) DeleteMfaAuthenticator() (*model.CommonMessageAndCode, error)

DeleteMfaAuthenticator 解绑 MFA

func (*Client) GenerateCodeChallenge 

func (c *Client) GenerateCodeChallenge(size int) (string, error)

GenerateCodeChallenge 生成一个 PKCE 校验码，长度必须大于等于 43。

func (*Client) GetAccessTokenByClientCredentials 

func (c *Client) GetAccessTokenByClientCredentials(req model.GetAccessTokenByClientCredentialsRequest) (string, error)

GetAccessTokenByClientCredentials Client Credentials 模式获取 Access Token

func (*Client) GetAccessTokenByCode 

func (c *Client) GetAccessTokenByCode(code string) (string, error)

GetAccessTokenByCode 

code 换取 accessToken

func (*Client) GetCodeChallengeDigest 

func (c *Client) GetCodeChallengeDigest(codeChallenge string, method constant.GenerateCodeChallengeMethod) (string, error)

GetCodeChallengeDigest 生成一个 PKCE 校验码摘要值

func (*Client) GetCurrentUser 

func (c *Client) GetCurrentUser(token *string) (*model.User, error)

GetCurrentUser 获取资源列表

func (*Client) GetMfaAuthenticators 

func (c *Client) GetMfaAuthenticators(req *model.MfaInput) (*struct {
	Message string                               `json:"message"`
	Code    int64                                `json:"code"`
	Data    []model.GetMfaAuthenticatorsResponse `json:"data"`
}, error)

GetMfaAuthenticators 获取 MFA 认证器

func (*Client) GetNewAccessTokenByRefreshToken 

func (c *Client) GetNewAccessTokenByRefreshToken(refreshToken string) (string, error)

GetNewAccessTokenByRefreshToken 

使用 Refresh token 获取新的 Access token

func (*Client) GetSecurityLevel 

func (c *Client) GetSecurityLevel() (*struct {
	Code    int64                          `json:"code"`
	Message string                         `json:"message"`
	Data    model.GetSecurityLevelResponse `json:"data"`
}, error)

GetSecurityLevel 用户安全等级

func (*Client) GetUserInfoByAccessToken 

func (c *Client) GetUserInfoByAccessToken(accessToken string) (string, error)

GetUserInfoByAccessToken accessToken 换取用户信息

func (*Client) HasRole 

func (c *Client) HasRole(code, namespace string) (*bool, error)

HasRole 判断当前用户是否有某个角色

func (*Client) IntrospectToken 

func (c *Client) IntrospectToken(token string) (string, error)

IntrospectToken 检查 Access token 或 Refresh token 的状态

func (*Client) IsUserExists 

func (c *Client) IsUserExists(req *model.IsUserExistsRequest) (*bool, error)

IsUserExists 判断用户是否存在

func (*Client) LinkAccount 

func (c *Client) LinkAccount(primaryUserToken, secondaryUserToken string) (*model.CommonMessageAndCode, error)

LinkAccount 关联账号

func (*Client) ListApplications 

func (c *Client) ListApplications(page, limit int) (*struct {
	Code    int64  `json:"code"`
	Message string `json:"message"`
	Data    struct {
		TotalCount int64               `json:"totalCount"`
		List       []model.Application `json:"list"`
	} `json:"data"`
}, error)

ListApplications 获取当前用户能够访问的应用

func (*Client) ListAuthorizedResources 

func (c *Client) ListAuthorizedResources(namespace string, resourceType model.EnumResourceType) (*model.AuthorizedResources, error)

ListAuthorizedResources 获取用户被授权的所有资源

func (*Client) ListDepartments 

func (c *Client) ListDepartments() (*model.PaginatedDepartments, error)

ListDepartments 获取用户所有部门

func (*Client) ListOrg 

func (c *Client) ListOrg() (*struct {
	Code    int64            `json:"code"`
	Message string           `json:"message"`
	Data    []model.UserOrgs `json:"data"`
}, error)

ListOrg 获取用户所在组织机构

func (*Client) ListRole 

func (c *Client) ListRole(namespace string) (*struct {
	TotalCount int               `json:"totalCount"`
	List       []model.RoleModel `json:"list"`
}, error)

ListRole 获取用户拥有的角色列表

func (*Client) ListUdv 

func (c *Client) ListUdv() (*[]model.UserDefinedData, error)

ListUdv 获取当前用户的自定义数据列表

func (*Client) LoginByAd 

func (c *Client) LoginByAd(username, password string) (*struct {
	Code    int64      `json:"code"`
	Message string     `json:"message"`
	Data    model.User `json:"data"`
}, error)

LoginByAd 使用 AD 用户名登录

func (*Client) LoginByEmail 

func (c *Client) LoginByEmail(request model.LoginByEmailInput) (*model.User, error)

LoginByEmail 使用邮箱登录

func (*Client) LoginByLdap 

func (c *Client) LoginByLdap(username, password string) (*struct {
	Code    int64      `json:"code"`
	Message string     `json:"message"`
	Data    model.User `json:"data"`
}, error)

LoginByLdap 使用 LDAP 用户名登录

func (*Client) LoginByPhoneCode 

func (c *Client) LoginByPhoneCode(req *model.LoginByPhoneCodeInput) (*model.User, error)

LoginByPhoneCode 使用手机号验证码登录

func (*Client) LoginByPhonePassword 

func (c *Client) LoginByPhonePassword(request model.LoginByPhonePasswordInput) (*model.User, error)

LoginByPhonePassword 使用手机号密码登录

func (*Client) LoginBySubAccount 

func (c *Client) LoginBySubAccount(req *model.LoginBySubAccountRequest) (*model.User, error)

LoginBySubAccount 登录子账号

func (*Client) LoginByUserName 

func (c *Client) LoginByUserName(request model.LoginByUsernameInput) (*model.User, error)

LoginByUserName 使用用户名登录

func (*Client) Logout 

func (c *Client) Logout() (*model.CommonMessageAndCode, error)

Logout 退出登录

func (*Client) LogoutByToken 

func (c *Client) LogoutByToken(token string) (*model.CommonMessageAndCode, error)

func (*Client) PhoneOrEmailBindable 

func (c *Client) PhoneOrEmailBindable(email, phone *string, token string) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

PhoneOrEmailBindable 检测手机号或邮箱是否已被绑定

func (*Client) RefreshToken 

func (c *Client) RefreshToken(token *string) (*model.RefreshToken, error)

RefreshToken 刷新当前用户的 token

func (*Client) RegisterByEmail 

func (c *Client) RegisterByEmail(request *model.RegisterByEmailInput) (*model.User, error)

RegisterByEmail 使用邮箱注册

func (*Client) RegisterByPhoneCode 

func (c *Client) RegisterByPhoneCode(request *model.RegisterByPhoneCodeInput) (*model.User, error)

RegisterByPhoneCode 使用手机号及验证码注册

func (*Client) RegisterByUsername 

func (c *Client) RegisterByUsername(request *model.RegisterByUsernameInput) (*model.User, error)

RegisterByUsername 使用用户名注册

func (*Client) RemoveUdv 

func (c *Client) RemoveUdv(key string) (*[]model.UserDefinedData, error)

RemoveUdv 删除自定义数据

func (*Client) ResetPasswordByEmailCode 

func (c *Client) ResetPasswordByEmailCode(email, code, newPassword string) (*model.CommonMessageAndCode, error)

ResetPasswordByEmailCode 通过邮件验证码重置密码

func (*Client) ResetPasswordByFirstLoginToken 

func (c *Client) ResetPasswordByFirstLoginToken(token, password string) (*model.CommonMessageAndCode, error)

ResetPasswordByFirstLoginToken 通过首次登录的 Token 重置密码

func (*Client) ResetPasswordByForceResetToken 

func (c *Client) ResetPasswordByForceResetToken(token, password, newPassword string) (*model.CommonMessageAndCode, error)

ResetPasswordByForceResetToken 通过密码强制更新临时 Token 修改密码

func (*Client) ResetPasswordByPhoneCode 

func (c *Client) ResetPasswordByPhoneCode(phone, code, newPassword string) (*model.CommonMessageAndCode, error)

ResetPasswordByPhoneCode 通过短信验证码重置密码

func (*Client) RevokeToken 

func (c *Client) RevokeToken(token string) (string, error)

RevokeToken 撤回 Access token 或 Refresh token

func (*Client) SendEmail 

func (c *Client) SendEmail(email string, scene model.EnumEmailScene) (*model.CommonMessageAndCode, error)

SendEmail 发送邮件

func (*Client) SendHttpRequest 

func (c *Client) SendHttpRequest(url string, method string, header map[string]string, body map[string]string) ([]byte, error)

func (*Client) SendHttpRequestCustomTokenManage 

func (c *Client) SendHttpRequestCustomTokenManage(url string, method string, token *string, query string, variables map[string]interface{}) ([]byte, error)

func (*Client) SendHttpRequestManage 

func (c *Client) SendHttpRequestManage(url string, method string, query string, variables map[string]interface{}) ([]byte, error)

func (*Client) SendHttpRestRequest 

func (c *Client) SendHttpRestRequest(url string, method string, token *string, variables map[string]interface{}) ([]byte, error)

func (*Client) SendHttpRestRequestNotToken 

func (c *Client) SendHttpRestRequestNotToken(url string, method string, variables map[string]interface{}) ([]byte, error)

func (*Client) SendSmsCode 

func (c *Client) SendSmsCode(phone string) (*struct {
	Message string `json:"message"`
	Code    int64  `json:"code"`
}, error)

SendSmsCode 发送短信验证码

func (*Client) SetCurrentUser 

func (c *Client) SetCurrentUser(user *model.User) (*model.User, error)

SetCurrentUser 设置当前用户

func (*Client) SetPublicKey added in v0.3.1 

func (c *Client) SetPublicKey(publicKey string)

func (*Client) SetToken 

func (c *Client) SetToken(token string)

SetToken 设置 Token

func (*Client) SetUdv 

func (c *Client) SetUdv(udvList []model.KeyValuePair) (*[]model.UserDefinedData, error)

SetUdv 添加自定义数据

func (*Client) TrackSession 

func (c *Client) TrackSession(code string, country, lang, state *string) (*struct {
	Code    int64       `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}, error)

TrackSession sso 检测登录态

func (*Client) UnBindEmail 

func (c *Client) UnBindEmail() (*model.User, error)

UnBindEmail 解绑邮箱号

func (*Client) UnBindPhone 

func (c *Client) UnBindPhone() (*model.User, error)

UnBindPhone 绑定手机号

func (*Client) UnLinkAccount 

func (c *Client) UnLinkAccount(primaryUserToken string, provider constant.SocialProviderType) (*model.CommonMessageAndCode, error)

UnLinkAccount 主账号解绑社会化登录账号

func (*Client) UpdateEmail 

func (c *Client) UpdateEmail(email, code string, oldEmail, oldEmailCode *string) (*model.User, error)

UpdateEmail 更新用户邮箱

func (*Client) UpdatePassword 

func (c *Client) UpdatePassword(oldPassword *string, newPassword string) (*model.User, error)

UpdatePassword 更新用户密码

func (*Client) UpdatePhone 

func (c *Client) UpdatePhone(phone, code string, oldPhone, oldPhoneCode *string) (*model.User, error)

UpdatePhone 更新用户手机号

func (*Client) UpdateProfile 

func (c *Client) UpdateProfile(req *model.UpdateUserInput) (*model.User, error)

UpdateProfile 修改用户资料

func (*Client) ValidateTicketV1 

func (c *Client) ValidateTicketV1(ticket, service string) (*struct {
	Valid    bool   `json:"code"`
	Message  string `json:"message"`
	Username string `json:"username"`
}, error)

ValidateTicketV1 检验 CAS 1.0 Ticket 合法性

func (*Client) ValidateTicketV2 

func (c *Client) ValidateTicketV2(ticket, service string, format constant.TicketFormat) (*struct {
	Code    int64       `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
}, error)

ValidateTicketV2 通过远端服务验证票据合法性

func (*Client) ValidateToken 

func (c *Client) ValidateToken(req model.ValidateTokenRequest) (string, error)

ValidateToken 效验Token合法性

func (*Client) VerifyAppEmailMfa 

func (c *Client) VerifyAppEmailMfa(email, code, token string) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

VerifyAppEmailMfa 检验二次验证 MFA 邮箱验证码

func (*Client) VerifyAppSmsMfa 

func (c *Client) VerifyAppSmsMfa(phone, code, token string) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

VerifyAppSmsMfa 检验二次验证 MFA 短信验证码

func (*Client) VerifyFaceMfa 

func (c *Client) VerifyFaceMfa(faceUrl, token string) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

VerifyFaceMfa 人脸二次认证

func (*Client) VerifyTotpMfa 

func (c *Client) VerifyTotpMfa(totp, token string) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

VerifyTotpMfa 检验二次验证 MFA 口令

func (*Client) VerifyTotpRecoveryCode 

func (c *Client) VerifyTotpRecoveryCode(code, token string) (*struct {
	Message string      `json:"message"`
	Code    int64       `json:"code"`
	Data    interface{} `json:"data"`
}, error)

VerifyTotpRecoveryCode 检验二次验证 MFA 恢复代码

Source Files

View all Source files

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.