msft_web

Documentation

Index

• type Provider
  • func New(clientKey *m.Secret[string], secret *m.Secret[string], callbackURL string, ...) *Provider
  • func (p *Provider) BeginAuth(state string) (soth.Session, error)
  • func (p *Provider) Debug(debug bool)
  • func (p *Provider) FetchUser(session soth.Session) (soth.User, error)
  • func (p *Provider) Name() string
  • func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
  • func (p *Provider) RefreshTokenAvailable() bool
  • func (p *Provider) SetName(name string)
  • func (p *Provider) UnmarshalSession(data string) (soth.Session, error)
• type Session
  • func (s *Session) Authorize(provider soth.Provider, params soth.Params) (string, error)
  • func (s Session) GetAuthURL() (string, error)
  • func (s Session) Marshal() string
  • func (s Session) String() string

Types

type Provider

type Provider struct {
	ClientKey   *m.Secret[string]
	Secret      *m.Secret[string]
	CallbackURL string

	ProviderName string
	// contains filtered or unexported fields
}

Provider is the implementation of `soth.Provider` for accessing microsoftonline.

func New

func New(clientKey *m.Secret[string], secret *m.Secret[string], callbackURL string, tenant string, scopes ...string) *Provider

New creates a new microsoftonline Provider, and sets up important connection details. You should always call `msft_web.New` to get a new Provider. Never try to create one manually.

func (*Provider) BeginAuth

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

BeginAuth asks MicrosoftOnline for an authentication end-point.

func (*Provider) Debug

func (p *Provider) Debug(debug bool)

Debug is a no-op for the msft package.

func (*Provider) FetchUser

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

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

func (*Provider) Name

func (p *Provider) Name() string

Name is the name used to retrieve this Provider later.

func (*Provider) RefreshToken

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

RefreshToken get new access token based on the refresh token

func (*Provider) RefreshTokenAvailable

func (p *Provider) RefreshTokenAvailable() bool

RefreshTokenAvailable refresh token is provided by auth Provider or not available for microsoft online as session size hit the limit of max cookie size

func (*Provider) SetName

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

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

UnmarshalSession wil unmarshal a JSON string into a session.

type Session

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

Session is the implementation of `soth.Session` for accessing microsoftonline. Refresh token not available for microsoft online: session size hit the limit of max cookie size

func (*Session) Authorize

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

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

func (Session) GetAuthURL

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

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

func (Session) Marshal

func (s Session) Marshal() string

Marshal the session into a string

func (Session) String

func (s Session) String() string