auth

Documentation

Index

• func AddUser(user *User) (bool, error)
• func CheckUserPassword(user *User) (bool, error)
• func DeleteResource(name string) (bool, error)
• func DeleteUser(user *User) (bool, error)
• func GetOAuthToken(code string, state string) (*oauth2.Token, error)
• func InitConfig(endpoint string, clientId string, clientSecret string, jwtSecret string, ...)
• func SendEmail(title string, content string, sender string, receivers ...string) error
• func SendSms(content string, receivers ...string) error
• func UpdateUser(user *User) (bool, error)
• func UploadResource(user string, tag string, parent string, fullFilePath string, fileBytes []byte) (string, string, error)
• type AuthConfig
• type Claims
  • func ParseJwtToken(token string) (*Claims, error)
• type Resource
• type Response
• type User
  • func GetUser(name string) (*User, error)
  • func GetUsers() ([]*User, error)

Functions

func AddUser

func AddUser(user *User) (bool, error)

func CheckUserPassword

func CheckUserPassword(user *User) (bool, error)

func DeleteResource

func DeleteResource(name string) (bool, error)

func DeleteUser

func DeleteUser(user *User) (bool, error)

func GetOAuthToken

func GetOAuthToken(code string, state string) (*oauth2.Token, error)

GetOAuthToken gets the pivotal and necessary secret to interact with the Casdoor server

func InitConfig

func InitConfig(endpoint string, clientId string, clientSecret string, jwtSecret string, organizationName string, applicationName string)

func SendEmail

func SendEmail(title string, content string, sender string, receivers ...string) error

func SendSms

func SendSms(content string, receivers ...string) error

func UpdateUser

func UpdateUser(user *User) (bool, error)

func UploadResource

func UploadResource(user string, tag string, parent string, fullFilePath string, fileBytes []byte) (string, string, error)

Types

type AuthConfig

type AuthConfig struct {
	Endpoint         string
	ClientId         string
	ClientSecret     string
	JwtSecret        string
	OrganizationName string
	ApplicationName  string
}

AuthConfig is the core configuration. The first step to use this SDK is to use the InitConfig function to initialize the global authConfig.

type Claims

type Claims struct {
	User
	AccessToken string `json:"accessToken"`
	jwt.RegisteredClaims
}

func ParseJwtToken

func ParseJwtToken(token string) (*Claims, error)

type Resource

type Resource struct {
	Owner string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name  string `xorm:"varchar(100) notnull pk" json:"name"`
}

Resource has the same definition as https://github.com/casbin/casdoor/blob/master/object/resource.go#L24 used to obtain resource-related information from Casdoor

type Response

type Response struct {
	Status string      `json:"status"`
	Msg    string      `json:"msg"`
	Data   interface{} `json:"data"`
	Data2  interface{} `json:"data2"`
}

type User

type User struct {
	Owner       string `xorm:"varchar(100) notnull pk" json:"owner"`
	Name        string `xorm:"varchar(100) notnull pk" json:"name"`
	CreatedTime string `xorm:"varchar(100)" json:"createdTime"`
	UpdatedTime string `xorm:"varchar(100)" json:"updatedTime"`

	Id                string   `xorm:"varchar(100)" json:"id"`
	Type              string   `xorm:"varchar(100)" json:"type"`
	Password          string   `xorm:"varchar(100)" json:"password"`
	DisplayName       string   `xorm:"varchar(100)" json:"displayName"`
	Avatar            string   `xorm:"varchar(255)" json:"avatar"`
	PermanentAvatar   string   `xorm:"varchar(255)" json:"permanentAvatar"`
	Email             string   `xorm:"varchar(100)" json:"email"`
	Phone             string   `xorm:"varchar(100)" json:"phone"`
	Location          string   `xorm:"varchar(100)" json:"location"`
	Address           []string `json:"address"`
	Affiliation       string   `xorm:"varchar(100)" json:"affiliation"`
	Title             string   `xorm:"varchar(100)" json:"title"`
	Homepage          string   `xorm:"varchar(100)" json:"homepage"`
	Bio               string   `xorm:"varchar(100)" json:"bio"`
	Tag               string   `xorm:"varchar(100)" json:"tag"`
	Region            string   `xorm:"varchar(100)" json:"region"`
	Language          string   `xorm:"varchar(100)" json:"language"`
	Score             int      `json:"score"`
	Ranking           int      `json:"ranking"`
	IsOnline          bool     `json:"isOnline"`
	IsAdmin           bool     `json:"isAdmin"`
	IsGlobalAdmin     bool     `json:"isGlobalAdmin"`
	IsForbidden       bool     `json:"isForbidden"`
	SignupApplication string   `xorm:"varchar(100)" json:"signupApplication"`
	Hash              string   `xorm:"varchar(100)" json:"hash"`
	PreHash           string   `xorm:"varchar(100)" json:"preHash"`

	Github   string `xorm:"varchar(100)" json:"github"`
	Google   string `xorm:"varchar(100)" json:"google"`
	QQ       string `xorm:"qq varchar(100)" json:"qq"`
	WeChat   string `xorm:"wechat varchar(100)" json:"wechat"`
	Facebook string `xorm:"facebook varchar(100)" json:"facebook"`
	DingTalk string `xorm:"dingtalk varchar(100)" json:"dingtalk"`
	Weibo    string `xorm:"weibo varchar(100)" json:"weibo"`
	Gitee    string `xorm:"gitee varchar(100)" json:"gitee"`
	LinkedIn string `xorm:"linkedin varchar(100)" json:"linkedin"`
	Wecom    string `xorm:"wecom varchar(100)" json:"wecom"`
	Lark     string `xorm:"lark varchar(100)" json:"lark"`
	Gitlab   string `xorm:"gitlab varchar(100)" json:"gitlab"`

	Ldap       string            `xorm:"ldap varchar(100)" json:"ldap"`
	Properties map[string]string `json:"properties"`
}

User has the same definition as https://github.com/casbin/casdoor/blob/master/object/user.go#L24 used to obtain user-related information from your Casdoor server.

func GetUser

func GetUser(name string) (*User, error)

func GetUsers

func GetUsers() ([]*User, error)