ftauthinternal

package
v0.0.0-...-a8587fa Latest Latest
Warning

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

 Go to latest Published: Nov 29, 2021 License: Apache-2.0 Imports: 17 Imported by: 0

README

FTAuth Mobile

Mobile bindings for the FTAuth Go client, allowing cross-platform deployment to iOS and Android.

Test

go test

Build

iOS
gomobile bind -target ios -o FTAuthInternal.framework

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrInvalidState = errors.New("invalid state")
)

Common errors.

Functions

func ErrAccess 

func ErrAccess(details string) error

ErrAccess creates an access error.

func ErrKeyNotFound 

func ErrKeyNotFound(key string) error

ErrKeyNotFound creates a key not found error.

func ErrUnknown 

func ErrUnknown(details string) error

ErrUnknown creates an unknown error.

Types

type AppleCredentialType 

type AppleCredentialType string

AppleCredentialType is the means through which the user authenticating using Sign In With Apple. 

const (
	AppleCredentialTypeAppleID  AppleCredentialType = "apple_id" // Apple ID
	AppleCredentialTypePassword AppleCredentialType = "password" // Username and password
)

Supported Apple credential types.

type AuthorizationCodeCompleter 

type AuthorizationCodeCompleter interface {
	Complete(authResp *AuthorizationCodeResponse, err error)
}

AuthorizationCodeCompleter handles client-side asynchronous completion of an authorization request.

type AuthorizationCodeResponse 

type AuthorizationCodeResponse ftauth.AuthorizationCodeResponse

AuthorizationCodeResponse holds the query parameters returned from a successful Authorize call, as well as an error if any error occurred.

func NewAuthorizationCodeResponse 

func NewAuthorizationCodeResponse(code, state string, err error) *AuthorizationCodeResponse

NewAuthorizationCodeResponse creates a new authorization code response with the query parameters of a successful callback.

type CertificateRepository 

type CertificateRepository ftauth.CertificateRepository

CertificateRepository holds a map of hosts to certificate pools for use with TLS handshake verification (i.e. certificate pinning).

func GetCertificateRepository 

func GetCertificateRepository() *CertificateRepository

GetCertificateRepository returns the main certificate repo for adding/removing security configurations.

func (*CertificateRepository) AddSecurityConfiguration 

func (cr *CertificateRepository) AddSecurityConfiguration(sc *SecurityConfiguration)

AddSecurityConfiguration configures the TLS client for request to the specified host.

func (*CertificateRepository) GetDefaultConfiguration 

func (cr *CertificateRepository) GetDefaultConfiguration() *SecurityConfiguration

GetDefaultConfiguration returns the default security configuration, i.e. the configuration used when a server's configuration has not been explicitly set.

func (*CertificateRepository) GetSecurityConfiguration 

func (cr *CertificateRepository) GetSecurityConfiguration(host string) *SecurityConfiguration

GetSecurityConfiguration returns the stored configuration for the given host, returning nil if not found.

func (*CertificateRepository) RemoveSecurityConfiguration 

func (cr *CertificateRepository) RemoveSecurityConfiguration(host string)

RemoveSecurityConfiguration resets the security configuration for the host, using the default security configuration instead.

func (*CertificateRepository) SetDefaultConfiguration 

func (cr *CertificateRepository) SetDefaultConfiguration(sc *SecurityConfiguration)

SetDefaultConfiguration sets the default security configuration, i.e. the configuration used when a server's configuration has not been explicitly set.

type Client 

type Client struct {
	*ft.Client
	// contains filtered or unexported fields
}

Client communicates with HTTP services on behalf of an authenticated user.

func NewClient 

func NewClient(config *Config) (*Client, error)

NewClient creates a new FTAuth client

func (*Client) Authorize 

func (c *Client) Authorize(provider model.Provider) (string, error)

Authorize returns a URL through which the user must authenticate. The client is responsible for listening to redirect steps and capturing the query parameters for use with Exchange.

func (*Client) Complete 

func (c *Client) Complete(authResp *AuthorizationCodeResponse, err error)

Complete handles completion of an authorization code request.

func (*Client) Exchange 

func (c *Client) Exchange(authResp *AuthorizationCodeResponse) (*http.Client, error)

Exchange communicates with the FTAuth server, exchanging the authorization code for an access + refresh token.

func (*Client) Login 

func (c *Client) Login(provider int, webView WebViewLauncher, completion LoginCompleter)

Login triggers the authentication flow and handles redirects on the mobile side to return an authenticated HTTP client.

func (*Client) Request 

func (c *Client) Request(request *Request) (*Response, error)

Request performs an HTTP request on behalf of an authenticated user.

func (*Client) SignInWithApple 

func (c *Client) SignInWithApple(user *SignInWithAppleData) (*UserData, error)

SignInWithApple is a special login function for working with Apple's login system on iOS 13. iOS 12 and all other providers use the Login function with the provider specified.

type ClientConfig 

type ClientConfig ft.ClientConfig

ClientConfig holds client options and settings.

func NewClientConfig 

func NewClientConfig(
	gatewayURL string,
	clientID string,
	clientSecret string,
	clientType string,
	redirectURI string,
	scope string,
	timeout int,
) (*ClientConfig, error)

NewClientConfig creates a new object holding all the information needed to initialize an FTAuth client.

type Config 

type Config ft.Config

Config holds options for configuring the client. Use DefaultOptions if unsure.

func NewConfig 

func NewConfig(
	keyStore KeyStore,
	logger Logger,
	clientConfig *ClientConfig,
) (*Config, error)

NewConfig creates an options object for configuring an FTAuth client.

func NewConfigWithJSON 

func NewConfigWithJSON(
	keyStore KeyStore,
	logger Logger,
	clientConfigJSON []byte,
) (*Config, error)

NewConfigWithJSON creates an options object for configuring an FTAuth client with client config in JSON format.

func (*Config) GetClientConfig 

func (config *Config) GetClientConfig() *ClientConfig

GetClientConfig returns the configured client options.

type ErrorCompleter 

type ErrorCompleter interface {
	Complete(err error)
}

ErrorCompleter completes with an error (or nil).

type KeyStore 

type KeyStore ft.KeyStore

KeyStore exchanges private key data with a backend keychain. Implementations will vary by client, but all should be encrypted or reasonably protected against attacks.

type Logger 

type Logger ft.Logger

Logger lets the mobile platform define the logging interface.

type LoginCompleter 

type LoginCompleter interface {
	Complete(user *UserData, err error)
}

LoginCompleter can be used by the mobile side to receive a notification when the login process completed successfully (with a username), or with an error.

type Request 

type Request ft.Request

Request holds an HTTP request.

func NewRequest 

func NewRequest(method, uri string, body []byte) *Request

NewRequest creates a new HTTP request

type Response 

type Response struct {
	Request    *Request
	StatusCode int
	Body       []byte
}

Response holds an HTTP response.

type SecurityConfiguration 

type SecurityConfiguration ftauth.SecurityConfiguration

SecurityConfiguration holds a host-specific configuration for the rules to use when verifying a TLS handshake.

func NewSecurityConfiguration 

func NewSecurityConfiguration(host string, trustPublicPKI bool) *SecurityConfiguration

NewSecurityConfiguration creates a new configuration object for the given host. Must call CertficateRepository.AddSecurityConfiguration() for it to take effect.

func (*SecurityConfiguration) AddIntermediateASN1 

func (sc *SecurityConfiguration) AddIntermediateASN1(asn1 []byte) error

AddIntermediateASN1 pins the intermediate certificate (in ASN1 DER format), adding it to the list of verified certificates for the host in this configuration.

func (*SecurityConfiguration) AddIntermediatePEM 

func (sc *SecurityConfiguration) AddIntermediatePEM(pem []byte) error

AddIntermediatePEM pins the intermediate certificate(s) (in PEM format), adding them to the list of verified certificates for the host in this configuration.

func (*SecurityConfiguration) ResetPinning 

func (sc *SecurityConfiguration) ResetPinning()

ResetPinning removes all intermediate certs and resets TrustSystemRoots to true.

type SignInWithApple 

type SignInWithApple interface {
	SignInWithApple(user *SignInWithAppleData) (*UserData, error)
}

SignInWithApple is the callback for the iOS13+ Sign In With Apple flow. Basically, it's the reverse of the typical flow, since the OAuth flow is handled by Apple, then we store a copy of the information on our end and convert it into a UserData object via the server.

type SignInWithAppleData 

type SignInWithAppleData struct {
	CredentialType AppleCredentialType

	// AppleCredentialTypeAppleID
	UserID         string
	AuthCode       []byte
	Scopes         []string
	IDToken        []byte
	Email          string
	FirstName      string
	LastName       string
	RealUserStatus int

	// AppleCredentialTypePassword
	Username string
	Password string
}

SignInWithAppleData holds the data we can expect to receive back from iOS after a successful login call, broken out by credential type.

func NewSignInWithAppleIDData 

func NewSignInWithAppleIDData(
	UserID string,
	AuthCode []byte,
	Scopes string,
	IDToken []byte,
	Email string,
	FirstName string,
	LastName string,
	RealUserStatus int,
) *SignInWithAppleData

NewSignInWithAppleIDData returns a data object for the Apple ID flow.

func NewSignInWithApplePasswordData 

func NewSignInWithApplePasswordData(username, password string) *SignInWithAppleData

NewSignInWithApplePasswordData returns a data object for the password flow.

func (*SignInWithAppleData) Valid 

func (data *SignInWithAppleData) Valid() error

Valid returns whether or not the data is valid, for ensuring we receive valid data from the mobile side.

type UserData 

type UserData model.UserData

UserData holds the key user data for sharing externally.

type WebViewLauncher 

type WebViewLauncher interface {
	LaunchURL(url string, completer AuthorizationCodeCompleter)
}

WebViewLauncher handles opening URLs on mobile/desktop clients.

Source Files

View all Source files

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.