applesignin

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Mar 8, 2023 License: MIT Imports: 15 Imported by: 0

README

Sign in with Apple Golang client library

Early version may be unstable

Install

go get -u github.com/albenik-go/apple-sign-in

Test server

Very usefull with ngrok

Run:

go run github.com/albenik-go/apple-sign-in/cmd/test-server -aud <audience> -team <team_id> -client <client_id> -key <key_id> -keyfile <pem_file_path> -redirect https://<ngrok_subdomain>.ngrok.io/callback

Then open http://localhost:8080 and follow instructions

Resources

Documentation

Index

Constants

View Source 
const (
	MaxExpiration = 15777000 * time.Second // half a year

	ResponseModeQuery = "query"
	ResponseModePost  = "form_post"

	ScopeEmail = "email"
	ScopeName  = "name"
)
View Source 
const (
	ReasonInvalidRequest       = "invalid_request"
	ReasonInvalidClient        = "invalid_client"
	ReasonInvalidGrant         = "invalid_grant"
	ReasonUnauthorizedClient   = "unauthorized_client"
	ReasonUnsupportedGrantType = "unsupported_grant_type"
	ReasonInvalidScope         = "invalid_scope"
)

Variables

View Source 
var (
	ErrSecretExpirationTimeTooFar = errors.New("exp is too far from now")
	ErrIDTokenMissing             = errors.New("missing id token")
	ErrNonceMismatch              = errors.New("nonce mismatch")
	ErrNoSuitableJWK              = errors.New("no suitable JWK")
)

Functions

func WithBaseURL 

func WithBaseURL(u string) func(*Client)

func WithHTTPClient 

func WithHTTPClient(h *http.Client) func(*Client)

func WithJWKProxy 

func WithJWKProxy(p jwkproxy.Interface) func(*Client)

func WithJWTParser 

func WithJWTParser(p *jwt.Parser) func(*Client)

Types

type Client 

type Client struct {
	RedirectURL string
	// contains filtered or unexported fields
}

func New 

func New(tid, cid, kid string, key interface{}, opts ...func(c *Client)) *Client

New instatinates a new client. Arguments: tid — teamID, cid — clientID, kid — keyID.

func (*Client) AuthURL 

func (c *Client) AuthURL(mode string, scopes []string, state, nonce string) string

func (*Client) ParseIDToken 

func (c *Client) ParseIDToken(token string) (*IDTokenClaims, error)

func (*Client) ParseIDTokenContext 

func (c *Client) ParseIDTokenContext(ctx context.Context, token string) (*IDTokenClaims, error)

func (*Client) ValidateCode 

func (c *Client) ValidateCode(code, nonce string, exp time.Duration) (*TokenResponse, error)

func (*Client) ValidateCodeContext 

func (c *Client) ValidateCodeContext(ctx context.Context, code, nonce string, exp time.Duration) (*TokenResponse, error)

func (*Client) ValidateRefreshToken 

func (c *Client) ValidateRefreshToken(token string, exp time.Duration) (*TokenResponse, error)

func (*Client) ValidateRefreshTokenContext 

func (c *Client) ValidateRefreshTokenContext(ctx context.Context, token string, exp time.Duration) (*TokenResponse, error)

type ErrorResponse 

type ErrorResponse struct {
	Reason string `json:"error"`
}

ErrorResponse see https://developer.apple.com/documentation/sign_in_with_apple/errorresponse.

func (*ErrorResponse) Error 

func (r *ErrorResponse) Error() string

type FlexBool 

type FlexBool bool

func (*FlexBool) UnmarshalText 

func (b *FlexBool) UnmarshalText(s []byte) error

type IDTokenClaims 

type IDTokenClaims struct {
	Iss            string      `json:"iss"`
	Sub            string      `json:"sub"`
	Aud            string      `json:"aud"`
	Iat            int64       `json:"iat"`
	Exp            interface{} `json:"exp"`
	Nonce          string      `json:"nonce,omitempty"`
	NonceSupported bool        `json:"nonce_supported"`
	AuthTime       int64       `json:"auth_time,omitempty"`
	AtHash         string      `json:"at_hash"`
	Email          string      `json:"email"`
	EmailVerified  FlexBool    `json:"email_verified"`   // apple returns as string "true"
	EmailPrivate   FlexBool    `json:"is_private_email"` // apple returns as string "true"
	RealUserStatus int8        `json:"real_user_status"`
}

func (*IDTokenClaims) Valid 

func (c *IDTokenClaims) Valid(h *jwt.ValidationHelper) error

Valid validates standard claims using jwt.ValidationHelper Validates time based claims "exp" (see: jwt.WithLeeway) Validates "aud" if present in claims. (see: jwt.WithAudience, jwt.WithoutAudienceValidation) Validates "iss" if option is provided (see: jwt.WithIssuer).

type TokenResponse 

type TokenResponse struct {
	ExpiresIn    int            `json:"expires_in"`
	IDToken      *IDTokenClaims `json:"id_token"`
	AccessToken  string         `json:"access_token"`
	RefreshToken string         `json:"refresh_token"`
	TokenType    string         `json:"token_type"`
}

Source Files

View all Source files

Directories

Path Synopsis
cmd
test-server

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.