README.md

oidc-cli

用于快速接入 OIDC 服务

Usage

import(
	"github.com/BingyanStudio/oidc-cli/oidc"
)

var oidcCli = oidc.NewClient(
	&oidc.Config{
		ClientID:     "CLIENT_ID",
		ClientSecret: "CLIENT_SECRET",
		RedirectURL:  "", // Frontend Callback URI
	},
)

func UserTokenHandler(c echo.Context) error {
	code := c.QueryParam("code")
	tokens, err := oidcCli.RetrieveTokens(code)
	if err != nil {
		...
	}

	log.Println(tokens)
	
	... // use the token & claims to further authorization
}

具体用法参见 example

对于获取的返回值ResponseTokens：

• IDToken 的 Claims 已解析至 ResponseTokens.IDTokenClaims

  字段如下

  type IDTokenClaims struct {
  	Issuer    string `json:"iss,omitempty"`
  	IssuedAt  int64  `json:"iat,omitempty"` // issue time of token
  	ExpiresAt int64  `json:"exp,omitempty"` // expire time of token
      
  	Audience  string `json:"aud,omitempty"`     // client id
  	Nounce    string `json:"nounce,omitempty"`  // ramdom generated by client
  	ATHash    string `json:"at_hash,omitempty"` // access token hash - for client to validate the access token
  	Subject   string `json:"sub,omitempty"`     // user id
  	Role      string `json:"rol,omitempty"`     // role of user
  	SessionId string `json:"sid,omitempty"`
  
  	Nickname string `json:"nickname,omitempty"`
  	Picture  string `json:"picture,omitempty"`
  	Gender   string `json:"gender,omitempty"`
  
  	Email         string `json:"email,omitempty"`
  	EmailVerified bool   `json:"email_verified,omitempty"`
  	Phone         string `json:"phone,omitempty"`
  	PhoneVerified bool   `json:"phone_verified,omitempty"`
  	Group         string `json:"group,omitempty"`
  }

  其中，sub 为用户的身份唯一标识符；身份信息的返回取决于 Scope 的设置。

• 库中封装的 Scope 默认为 []string{oidc.ScopeOpenID, ScopeProfile, ScopePhone, ScopeEmail}

• 若要实现用户令牌的刷新，需以适当的方法存储 ResponseTokens.IDToken 与 ResponseTokens.RefreshToken。当刷新 RP 的 Token 时需确定 IDToken 的有效性。