ucs

README

ucs-go-sdk

用于集成ucs的开发包

快速开始

安装

go get -u github.com/Macrow/ucs-go-sdk

验证Jwt

validator := NewValidator(rsaPublicKey)
jwtUser, err := validator.ValidateJwt(token)

创建连接UCS的客户端

client := NewRpcClient("your.domain.com:port") // Rpc客户端
// client := NewTLSRpcClient(certFile, "your.domain.com:port") // TLS连接下的Rpc客户端，需要UCS服务也同时开启
// client := NewHttpClient("https://your.domain.com:port", yourAccessCode) // Http客户端
client.SetToken(token)

UCS服务端验证Jwt

err := client.ValidateJwt()

UCS服务端验证操作码

err := client.ValidatePermOperationByCode("UCS_O_CODE")

UCS服务端验证接口

err := client.ValidatePermAction("ucs", "/api/v1/ucs/users", "get")

UCS服务端验证用户是否拥有机构权限

err := client.ValidatePermOrgById("org_id_is_here")

Documentation

Index

• Constants
• func GetUserJwtCacheKey(prefix, userId, deviceId string) string
• func IsSame(u1 *RawJwtUser, u2 *RawJwtUser) bool
• type Client
  • func NewHttpClient(baseUrl string, accessCode string) Client
  • func NewRpcClient(addr string) Client
  • func NewTLSRpcClient(cert []byte, addr string) Client
• type CommonPermitResult
• type CommonRenewTokenResult
• type HttpClient
  • func (c *HttpClient) SetHttpHeaderNames(accessCodeHeader, randomKeyHeader string) Client
  • func (c *HttpClient) SetTimeout(timeout int) Client
  • func (c *HttpClient) SetToken(token string) Client
  • func (c *HttpClient) ValidateJwt() error
  • func (c *HttpClient) ValidatePermAction(service, path, method string) error
  • func (c *HttpClient) ValidatePermOperationByCode(operationCode string) error
  • func (c *HttpClient) ValidatePermOrgById(orgId string) error
• type JwtUser
  • func GenerateJwt(privateKey []byte, id, username, deviceId, deviceName, issuer string, ...) (jwtUser *JwtUser, err error)
  • func ValidateJwt(publicKey []byte, tokenString string) (*JwtUser, error)
• type NormalHttpResponse
• type PermitHttpResponse
• type RawJwtUser
• type RenewTokenHttpResponse
• type RpcClient
  • func (c *RpcClient) SetHttpHeaderNames(accessCodeHeader, randomKeyHeader string) Client
  • func (c *RpcClient) SetTimeout(timeout int) Client
  • func (c *RpcClient) SetToken(token string) Client
  • func (c *RpcClient) ValidateJwt() error
  • func (c *RpcClient) ValidatePermAction(service, path, method string) error
  • func (c *RpcClient) ValidatePermOperationByCode(operationCode string) error
  • func (c *RpcClient) ValidatePermOrgById(orgId string) error
• type Validator
  • func NewValidator(publicKey []byte) *Validator
  • func (v *Validator) ValidateJwt(tokenString string) (user *JwtUser, err error)

Constants

const (
	DefaultHeaderRandomKey  = "Random-Key"
	DefaultHeaderAccessCode = "Access-Code"
	DefaultNoPermMsg        = "权限不足"
	DefaultTimeout          = 3

	ValidateJwtURL                 = "/api/v1/ucs/current/blank"
	ValidatePermOperationByCodeURL = "/api/v1/ucs/current/check-operation"
	ValidatePermActionURL          = "/api/v1/ucs/current/check-action"
	ValidatePermOrgByIdURL         = "/api/v1/ucs/current/check-org"
	ValidateRenewTokenURL          = "/api/v1/ucs/public/renew-token"
)

const (
	JwtTokenClaimsId         = "id"
	JwtTokenClaimsName       = "name"
	JwtTokenClaimsDeviceId   = "did"
	JwtTokenClaimsDeviceName = "dn"
	JwtTokenClaimsIssuer     = "iss"
	JwtTokenClaimsIssueAt    = "iat"
	JwtTokenClaimsExpireAt   = "exp"
)

const (
	JwtKeySplitter = "_"
	JwtErrInternal = "内部错误"
	JwtErrFormat   = "令牌格式错误"
	JwtErrVersion  = "令牌版本错误"
)

Functions

func GetUserJwtCacheKey

func GetUserJwtCacheKey(prefix, userId, deviceId string) string

GetUserJwtCacheKey 获取Jwt存储的key

func IsSame

func IsSame(u1 *RawJwtUser, u2 *RawJwtUser) bool

Types

type Client

type Client interface {
	SetTimeout(timeout int) Client
	SetToken(token string) Client
	SetHttpHeaderNames(accessCodeHeader, randomKeyHeader string) Client
	ValidateJwt() error
	ValidatePermOperationByCode(operationCode string) error
	ValidatePermAction(service, path, method string) error
	ValidatePermOrgById(orgId string) error
}

func NewHttpClient

func NewHttpClient(baseUrl string, accessCode string) Client

func NewRpcClient

func NewRpcClient(addr string) Client

func NewTLSRpcClient

func NewTLSRpcClient(cert []byte, addr string) Client

type CommonPermitResult

type CommonPermitResult struct {
	Permit bool `json:"permit"`
}

type CommonRenewTokenResult

type CommonRenewTokenResult struct {
	Token string `json:"token"`
}

type HttpClient

type HttpClient struct {
	// contains filtered or unexported fields
}

func (*HttpClient) SetHttpHeaderNames

func (c *HttpClient) SetHttpHeaderNames(accessCodeHeader, randomKeyHeader string) Client

func (*HttpClient) SetTimeout

func (c *HttpClient) SetTimeout(timeout int) Client

func (*HttpClient) SetToken

func (c *HttpClient) SetToken(token string) Client

func (*HttpClient) ValidateJwt

func (c *HttpClient) ValidateJwt() error

func (*HttpClient) ValidatePermAction

func (c *HttpClient) ValidatePermAction(service, path, method string) error

func (*HttpClient) ValidatePermOperationByCode

func (c *HttpClient) ValidatePermOperationByCode(operationCode string) error

func (*HttpClient) ValidatePermOrgById

func (c *HttpClient) ValidatePermOrgById(orgId string) error

type JwtUser

type JwtUser struct {
	RawJwtUser
	Token string `json:"token"` // 令牌字符串
}

func GenerateJwt

func GenerateJwt(privateKey []byte, id, username, deviceId, deviceName, issuer string, issueAt float64, expireAt float64) (jwtUser *JwtUser, err error)

func ValidateJwt

func ValidateJwt(publicKey []byte, tokenString string) (*JwtUser, error)

type NormalHttpResponse

type NormalHttpResponse struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Result  interface{} `json:"result"`
}

type PermitHttpResponse

type PermitHttpResponse struct {
	Code    int                `json:"code"`
	Message string             `json:"message"`
	Result  CommonPermitResult `json:"result"`
}

type RawJwtUser

type RawJwtUser struct {
	Id         string  `json:"id"`   // 用户id
	Name       string  `json:"name"` // 用户登录名
	DeviceId   string  `json:"did"`  // 设备id
	DeviceName string  `json:"dn"`   // 设备名
	Issuer     string  `json:"iss"`  // 签发者
	IssueAt    float64 `json:"iat"`  // 签发时间
	ExpireAt   float64 `json:"exp"`  // 过期时间
}

type RenewTokenHttpResponse

type RenewTokenHttpResponse struct {
	Code    int                    `json:"code"`
	Message string                 `json:"message"`
	Result  CommonRenewTokenResult `json:"result"`
}

type RpcClient

type RpcClient struct {
	// contains filtered or unexported fields
}

func (*RpcClient) SetHttpHeaderNames

func (c *RpcClient) SetHttpHeaderNames(accessCodeHeader, randomKeyHeader string) Client

func (*RpcClient) SetTimeout

func (c *RpcClient) SetTimeout(timeout int) Client

func (*RpcClient) SetToken

func (c *RpcClient) SetToken(token string) Client

func (*RpcClient) ValidateJwt

func (c *RpcClient) ValidateJwt() error

func (*RpcClient) ValidatePermAction

func (c *RpcClient) ValidatePermAction(service, path, method string) error

func (*RpcClient) ValidatePermOperationByCode

func (c *RpcClient) ValidatePermOperationByCode(operationCode string) error

func (*RpcClient) ValidatePermOrgById

func (c *RpcClient) ValidatePermOrgById(orgId string) error

type Validator

type Validator struct {
	// contains filtered or unexported fields
}

func NewValidator

func NewValidator(publicKey []byte) *Validator

func (*Validator) ValidateJwt

func (v *Validator) ValidateJwt(tokenString string) (user *JwtUser, err error)