auth

package module

Go to main page

Versions in this module

v1

v1.4.2

Oct 29, 2023

v1.4.1

Oct 29, 2023

v1.4.0

Oct 22, 2023

v1.3.3

Apr 11, 2023

Changes in this version

type Jwt

+ AutoExtendInMinutes int

+ AutoRefreshToken bool

v1.3.2

Mar 8, 2023

Changes in this version

type Jwt

+ DebugMode bool

v1.3.1

Mar 7, 2023

v1.3.0

Mar 7, 2023

Changes in this version

+ const DefaultAlgorithm

type Jwt

+ Algorithm string

type RedisJwtUtil

+ Method jwt.SigningMethod

v1.2.2

Jan 1, 2023

Changes in this version

+ const TraceId

type Service

+ EnableTraceLog bool

v1.2.1

Dec 28, 2022

v1.2.0

Dec 27, 2022

Changes in this version

+ const MsgAESKeyError

+ const MsgDecryptFail

+ const MsgEmptyContent

+ const MsgEncryptFail

+ var ErrAESKeyFail = errors.New(MsgAESKeyError)

+ var ErrDecryptFail = errors.New(MsgDecryptFail)

+ var ErrEmptyContent = errors.New(MsgEmptyContent)

+ var ErrEncryptFail = errors.New(MsgEncryptFail)

+ func AesEcbDecrypt(plainText, secretKey []byte) (cipherText []byte, err error)

+ func AesEcbDecryptByBase64(cipherTextBase64 string, key []byte) (plainText []byte, err error)

+ func AesEcbEncrypt(plainText, secretKey []byte) (cipherText []byte, err error)

+ func AesEcbEncryptBase64(plainText, key []byte) (cipherTextBase64 string, err error)

+ func PKCS5Padding(plainText []byte, blockSize int) []byte

+ func PKCS5UnPadding(plainText []byte, blockSize int) ([]byte, error)

type AccessCode

+ EncryptContent bool

+ type AesUtil struct

+ func NewAesUtil(key string) *AesUtil

+ func (a *AesUtil) CryptBlocks(block cipher.BlockMode, dist, src []byte, errCatch error)

type Client

+ EncryptContent bool

type ClientOption

+ func WithHttpClientLogger(logger logr.Logger) ClientOption

type HttpClient

+ AesUtil *AesUtil

type LocalAccessCode

+ EncryptContent bool

type LocalAuthChecker

+ AesUtil *AesUtil

type LocalCheckerOption

+ func WithAuthCheckerLogger(logger logr.Logger) LocalCheckerOption

type LocalClient

+ EncryptContent bool

type LocalRandomKey

+ EncryptContent bool

type RandomKey

+ EncryptContent bool

type Service

+ EncryptKey string

v1.1.4

Oct 20, 2022

v1.1.3

Oct 17, 2022

v1.1.2

Oct 16, 2022

v1.1.1

Oct 16, 2022

v1.1.0

Oct 16, 2022

Changes in this version

+ const CodeSuccess

+ const MsgAccessCodeEmpty

+ const MsgNoResult

+ const MsgRandomKeyEmpty

+ const MsgRateLimit

+ var ErrAccessCodeEmpty = errors.New(MsgAccessCodeEmpty)

+ var ErrAuthFail = errors.New(MsgAuthFail)

+ var ErrAuthServerFail = errors.New(MsgAuthServerFail)

+ var ErrClientIdOrSecretEmpty = errors.New(MsgClientIdOrSecretEmpty)

+ var ErrClientTokenEmpty = errors.New(MsgClientTokenEmpty)

+ var ErrClientTokenFail = errors.New(MsgClientTokenFail)

+ var ErrInternalError = errors.New(MsgInternalError)

+ var ErrJwtErrFormat = errors.New(MsgJwtErrFormat)

+ var ErrJwtErrVersion = errors.New(MsgJwtErrVersion)

+ var ErrNoResult = errors.New(MsgNoResult)

+ var ErrPermFail = errors.New(MsgPermFail)

+ var ErrRandomKeyEmpty = errors.New(MsgRandomKeyEmpty)

+ var ErrRateLimit = errors.New(MsgRateLimit)

+ var ErrUserTokenEmpty = errors.New(MsgUserTokenEmpty)

+ func ExtractAccessCode(f GetHeaderFun, header string) (string, error)

+ func ExtractRandomKey(f GetHeaderFun, header string) (string, error)

type ClientOption

+ func WithLogger(logger logr.Logger) ClientOption

type HttpClient

+ func (c *HttpClient) ClientRequest(urlPath string, httpMethod string, queryParam map[string]any, ...) (any, error)

+ type HttpResult struct

+ Code int

+ Message string

+ Result any

+ Success bool

+ type PagedResult struct

+ Items []any

+ Page int

+ PageSize int

+ Total int

v1.0.0

Oct 16, 2022

Changes in this version

+ const ClientIdAndSecretSplitter

+ const DefaultCachePrefix

+ const DefaultCacheSplitter

+ const DefaultHeaderAccessCode

+ const DefaultHeaderClientToken

+ const DefaultHeaderRandomKey

+ const DefaultHeaderSchema

+ const DefaultHeaderUserToken

+ const DefaultIssuer

+ const DefaultMetaBy

+ const DidAndIatJoiner

+ const JwtTokenClaimsDeviceId

+ const JwtTokenClaimsExpireAt

+ const JwtTokenClaimsId

+ const JwtTokenClaimsIssueAt

+ const JwtTokenClaimsIssuer

+ const JwtTokenClaimsKind

+ const JwtTokenClaimsName

+ const KeyClientId

+ const KeyCustomAuth

+ const KeyCustomPerm

+ const KeyJwtUser

+ const KeyMetaBy

+ const KeySkipAuthCheck

+ const MsgAuthFail

+ const MsgAuthServerFail

+ const MsgClientAccessCodeEmpty

+ const MsgClientIdOrSecretEmpty

+ const MsgClientTokenEmpty

+ const MsgClientTokenFail

+ const MsgInternalError

+ const MsgJwtErrFormat

+ const MsgJwtErrVersion

+ const MsgPermFail

+ const MsgServerFail

+ const MsgUserTokenEmpty

+ const MsgUserTokenFail

+ const UrlPostCheckAuth

+ const UrlPostCheckClientAuth

+ const UrlPostCheckClientPermByCode

+ const UrlPostCheckPermByAction

+ const UrlPostCheckPermByCode

+ var NoAuthError = errors.New("权限验证失败")

+ var RateLimitError = errors.New("访问过于频繁")

+ func ExtractClientInfoAndToken(f GetHeaderFun, header, headerSchema string) (clientId string, clientSecret string, schemaAndToken string, err error)

+ func ExtractCommonHeader(f GetHeaderFun, header string) string

+ func ExtractUserToken(fun GetHeaderFun, header, headerSchema string) (string, error)

+ func GenerateClientToken(clientId string, clientSecret string) string

+ func GenerateRandomKey() string

+ func GetClientId(f GetValFunc) interface

+ func GetCustomAuth(f GetValFunc) interface

+ func GetCustomPerm(f GetValFunc) interface

+ func GetMetaBy(f GetValFunc) string

+ func GetNonEmptyValue(val string) string

+ func GetNonEmptyValueWithBackup(val string, backup string) string

+ func GetSkipAuthCheck(f GetValFunc) bool

+ func ParseClientToken(clientToken string) (clientId string, clientSecret string, err error)

+ func SetClientId(clientId string, f SetValFunc)

+ func SetCustomAuth(customAuth interface{}, f SetValFunc)

+ func SetCustomPerm(customAuth interface{}, f SetValFunc)

+ func SetJwtUser(jwtUser *JwtUser, f SetValFunc)

+ func SetMetaBy(metaBy string, f SetValFunc)

+ func SetSkipAuthCheck(skip bool, f SetValFunc)

+ type AccessCode struct

+ Enable bool

+ Header string

+ SkipUserTokenCheck bool

+ type Auditing struct

+ MetaBy string

+ type CheckAuthResult struct

+ CustomAuth interface{}

+ SkippedAuthCheck bool

+ User *JwtUser

+ type CheckClientAuthResult struct

+ ClientAuthOk bool

+ type CheckClientPermResult struct

+ ClientPermOk bool

+ type CheckPermResult struct

+ CustomAuth interface{}

+ CustomPerm interface{}

+ SkippedAuthCheck bool

+ User *JwtUser

+ type Client struct

+ AccessCode string

+ EnableIdAndSecret bool

+ Header string

+ HeaderSchema string

+ Id string

+ Secret string

+ type ClientOption func(*HttpClient)

+ func WithAccessCodeConfig(config AccessCode) ClientOption

+ func WithAuditingConfig(config Auditing) ClientOption

+ func WithClientConfig(config Client) ClientOption

+ func WithRandomKeyConfig(config RandomKey) ClientOption

+ func WithUserConfig(config User) ClientOption

+ type GetHeaderFun = func(key string) string

+ type GetValFunc = func(Key string) interface

+ type HttpClient struct

+ Agent *req.Client

+ Config *HttpClientConfig

+ func NewHttpClient(AuthServiceBaseUrl string, CurrentServiceName string, options ...ClientOption) *HttpClient

+ func (c *HttpClient) CheckAuth(f GetHeaderFun, fulfillCustomAuth bool) *CheckAuthResult

+ func (c *HttpClient) CheckClientAuth(f GetHeaderFun) *CheckClientAuthResult

+ func (c *HttpClient) CheckClientPermByCode(f GetHeaderFun, code string) *CheckClientPermResult

+ func (c *HttpClient) CheckPermByAction(f GetHeaderFun, service string, method string, path string, fulfillJwt bool, ...) *CheckPermResult

+ func (c *HttpClient) CheckPermByCode(f GetHeaderFun, code string, fulfillJwt bool, fulfillCustomAuth bool, ...) *CheckPermResult

+ type HttpClientConfig struct

+ type HttpResponse struct

+ Code int

+ Message string

+ Result T

+ Success bool

+ type IAuthCheck interface

+ CheckAuth func(ctx context.Context, userToken string, fulfillCustomAuth bool) (*CheckAuthResult, error)

+ CheckClientAuth func(ctx context.Context, clientId string, clientSecret string) (*CheckClientAuthResult, error)

+ CheckClientPermByCode func(ctx context.Context, clientId string, clientSecret string, code string) (*CheckClientPermResult, error)

+ CheckPermByAction func(ctx context.Context, userToken string, service string, method string, ...) (CheckPermResult, error)

+ CheckPermByCode func(ctx context.Context, userToken string, code string, fulfillJwt bool, ...) (*CheckPermResult, error)

+ IsAccessCodeOk func(ctx context.Context, code string) (bool, error)

+ IsRandomKeyOk func(ctx context.Context, key string) (bool, error)

+ type IAuthClient interface

+ CheckAuth func(f GetHeaderFun, fulfillCustomAuth bool) *CheckAuthResult

+ CheckClientAuth func(f GetHeaderFun) *CheckClientAuthResult

+ CheckClientPermByCode func(f GetHeaderFun, code string) *CheckClientPermResult

+ CheckPermByAction func(f GetHeaderFun, service string, method string, path string, fulfillJwt bool, ...) *CheckPermResult

+ CheckPermByCode func(f GetHeaderFun, code string, fulfillJwt bool, fulfillCustomAuth bool, ...) *CheckPermResult

+ type Jwt struct

+ CacheSplitter string

+ ExpireInMinutes int

+ Issuer string

+ Prefix string

+ PrivateKey []byte

+ PublicKey []byte

+ type JwtUser struct

+ Token string

+ func GetJwtUser(f GetValFunc) *JwtUser

+ type JwtUtilConfig struct

+ type JwtUtilOption func(util *RedisJwtUtil)

+ func WithJwtConfig(config Jwt) JwtUtilOption

+ func WithRedisConfig(config Redis) JwtUtilOption

+ type LocalAccessCode struct

+ Enable bool

+ Header string

+ type LocalAuditing struct

+ MetaBy string

+ type LocalAuthChecker struct

+ Config *LocalAuthCheckerConfig

+ func NewLocalAuthChecker(options ...LocalCheckerOption) *LocalAuthChecker

+ func (c *LocalAuthChecker) ExtractAccessCode(f GetHeaderFun) string

+ func (c *LocalAuthChecker) ExtractClientInfoAndToken(f GetHeaderFun) (string, string, string, error)

+ func (c *LocalAuthChecker) ExtractRandomKey(f GetHeaderFun) string

+ func (c *LocalAuthChecker) ExtractUserToken(f GetHeaderFun) (string, error)

+ type LocalAuthCheckerConfig struct

+ type LocalCheckerOption func(checker *LocalAuthChecker)

+ func WithLocalAccessCodeConfig(config LocalAccessCode) LocalCheckerOption

+ func WithLocalAuditingConfig(config LocalAuditing) LocalCheckerOption

+ func WithLocalClientConfig(config LocalClient) LocalCheckerOption

+ func WithLocalRandomKeyConfig(config LocalRandomKey) LocalCheckerOption

+ func WithLocalUserConfig(config LocalUser) LocalCheckerOption

+ type LocalClient struct

+ EnableIdAndSecret bool

+ Header string

+ HeaderSchema string

+ type LocalRandomKey struct

+ Enable bool

+ Header string

+ type LocalUser struct

+ Header string

+ HeaderSchema string

+ type RandomKey struct

+ Enable bool

+ Header string

+ type RawJwtUser struct

+ Did string

+ Exp float64

+ Iat float64

+ Id string

+ Iss string

+ Kind string

+ Name string

+ type Redis struct

+ Address string

+ Db int

+ Password string

+ type RedisJwtUtil struct

+ Config JwtUtilConfig

+ Ctx context.Context

+ PrivateKey *rsa.PrivateKey

+ PublicKey *rsa.PublicKey

+ RateLimiter *redis_rate.Limiter

+ RedisClient *redis.Client

+ RedisClusterClient *redis.ClusterClient

+ func NewRedisJwtUtil(ctx context.Context, options ...JwtUtilOption) *RedisJwtUtil

+ func (j *RedisJwtUtil) CheckJwtIsInCache(jwtUser *JwtUser) bool

+ func (j *RedisJwtUtil) ClearRedisCachesByKey(key string)

+ func (j *RedisJwtUtil) ClearRedisCachesByKeyPattern(keyPattern string)

+ func (j *RedisJwtUtil) DelJwtByUserId(id string)

+ func (j *RedisJwtUtil) DelJwtByUserIdAndDeviceId(id, did string)

+ func (j *RedisJwtUtil) DelJwtByUserIdAndDeviceIdAndIat(id, did string, iat float64)

+ func (j *RedisJwtUtil) GenerateJwt(id, username, kind, deviceId string, issueAt float64, expireAt float64) (jwtUser *JwtUser, err error)

+ func (j *RedisJwtUtil) GetJwtUserByUserId(key string) *JwtUser

+ func (j *RedisJwtUtil) GetObjInRedis(key string) []byte

+ func (j *RedisJwtUtil) GetUserDidJwtCacheKeyPrefix(id, did string) string

+ func (j *RedisJwtUtil) GetUserJwtCacheKey(id, did string, iat float64) string

+ func (j *RedisJwtUtil) GetUserJwtCacheKeyPrefix(id string) string

+ func (j *RedisJwtUtil) IsRedisCluster() bool

+ func (j *RedisJwtUtil) RateLimitByMinute(key string, timesPerMinute int) error

+ func (j *RedisJwtUtil) RateLimitBySecond(key string, timesPerSecond int) error

+ func (j *RedisJwtUtil) SetJwtUser(jwtUser *JwtUser)

+ func (j *RedisJwtUtil) SetObjInRedis(key string, obj interface{}, expiredInMinutes int)

+ func (j *RedisJwtUtil) SignJwtAndSaveToCache(id, name, kind, did string) *JwtUser

+ func (j *RedisJwtUtil) ValidateJwt(tokenString string) (*JwtUser, error)

+ type Result interface

+ type Service struct

+ AuthServiceBaseUrl string

+ CurrentServiceName string

+ type SetValFunc = func(key string, val interface{})

+ type User struct

+ Header string

+ HeaderSchema string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL