goth: github.com/markbates/goth/providers/cloudfoundry Index | Files

package cloudfoundry

import "github.com/markbates/goth/providers/cloudfoundry"

Package cloudfoundry implements the OAuth2 protocol for authenticating users through Cloud Foundry. This package can be used as a reference implementation of an OAuth2 provider for Goth.

Index

Package Files

cf.go session.go

type Provider Uses

type Provider struct {
    AuthURL     string
    TokenURL    string
    UserInfoURL string
    ClientKey   string
    Secret      string
    CallbackURL string
    HTTPClient  *http.Client
    // contains filtered or unexported fields
}

Provider is the implementation of `goth.Provider` for accessing Cloud Foundry.

func New Uses

func New(uaaURL, clientKey, secret, callbackURL string, scopes ...string) *Provider

New creates a new Cloud Foundry provider and sets up important connection details. You should always call `cloudfoundry.New` to get a new provider. Never try to create one manually.

func (*Provider) BeginAuth Uses

func (p *Provider) BeginAuth(state string) (goth.Session, error)

BeginAuth asks Cloud Foundry for an authentication end-point.

func (*Provider) Client Uses

func (p *Provider) Client() *http.Client

func (*Provider) Debug Uses

func (p *Provider) Debug(debug bool)

Debug is a no-op for the cloudfoundry package.

func (*Provider) FetchUser Uses

func (p *Provider) FetchUser(session goth.Session) (goth.User, error)

FetchUser will go to Cloud Foundry and access basic information about the user.

func (*Provider) Name Uses

func (p *Provider) Name() string

Name is the name used to retrieve this provider later.

func (*Provider) RefreshToken Uses

func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable Uses

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth provider or not

func (*Provider) SetName Uses

func (p *Provider) SetName(name string)

SetName is to update the name of the provider (needed in case of multiple providers of 1 type)

func (*Provider) UnmarshalSession Uses

func (p *Provider) UnmarshalSession(data string) (goth.Session, error)

UnmarshalSession wil unmarshal a JSON string into a session.

type Session Uses

type Session struct {
    AuthURL      string
    AccessToken  string
    RefreshToken string
    ExpiresAt    time.Time
}

Session stores data during the auth process with Cloud Foundry.

func (*Session) Authorize Uses

func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error)

Authorize the session with Cloud Foundry and return the access token to be stored for future use.

func (Session) GetAuthURL Uses

func (s Session) GetAuthURL() (string, error)

GetAuthURL will return the URL set by calling the `BeginAuth` function on the Cloud Foundry provider.

func (Session) Marshal Uses

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String Uses

func (s Session) String() string

Package cloudfoundry imports 12 packages (graph) and is imported by 2 packages. Updated 2017-08-02. Refresh now. Tools for package owners.