oauth

README

OAuth module

Deprecation Notice

This module is deprecated, flamingo.me/flamingo/v3/core/auth should be used instead.

---

OpenId connect implementation to login against a configured SSO

Configuration example

core:
  oauth:
      server: flamingo.os.env.OAUTH_SERVER
      secret: flamingo.os.env.OAUTH_SECRET
      clientid: flamingo.os.env.OAUTH_CLIENTID
      disableOfflineToken: true

Specific scopes

By default, email and profile are added into scopes list (openid scope is attached always to the list, so it's not necessary to add it).

oauth:
  ...
  scopes:
  - email
  - profile
  - address

Specific claims

As openid connect standard it's possible to require claims in auth request. By default, claims are empty, but it's possible to define a list of voluntaries claims as a list named "claims".

oauth:
  ...
  claims:
  - someName
  - someEmail
  - someSalutation

Specific mapping

If it's necessary, fields from id_token and userinfo can be mapped to the actual user entity. By default, only sub, name and email fields are mapped.

To map to a specific field, use top-level attribute mapping (in example, fields, like someEmail or someName from id_token, would be mapped to desired fields email and name in the user entity).

oauth:
  ...
  mapping.idToken:
    sub: someSub
    name: someName
    email: someEmail
    salutation: someSalutation
    firstName: someFirstName
    lastName: someLastName
    street: someStreet
    zipCode: someZipCode
    city: someCity
    dateOfBirth: someDateOfBirth
    country: someCountry
    groups: groupfield1;groupfield2
    customFields:
    - someField1
    - someField2

As you see above the mapping allows to specify multiple keys in the claim. So groups: groupfield1;groupfield2 will map the group property of the user object from the claim groupfield1 and if that is not present it will use groupfield2.

Use fakes

For testing purposes it's possible to use fakes. In this case, login/logout process is simulated and it doesn't use any real SSO service. Still, all login and logout links are valid and clickable, and user data provided from UserService is still present, after "login". Whole process simply redirects to internal pages and handle session user data. To specify using of fake services and user data, check configuration below. Attribute names used for fakeUserData are the same ones used for id_token mapping.

oauth:
  ...
  useFake: true
  fakeLoginTemplate: "fake/login"
  fakeUserData:
    sub: ID123456
    email: email@domain.com
    name: "Mr. Flamingo"
    ...

It's possible to provide fake login page. In this case, the template for fake login page would be shown. Expected behaviour would be to have a login button that points to auth.callback handler, so it can finish the login process. Fake user data is stored in session anyway, but with fakeLoginTemplate parameter it's allowed to add a dummy login page in the middle of fake auth process.

html
  ...
  a(href=url("auth.callback")) Login

Debugging

Start flamingo with the environment variable "OAUTHDEBUG" - to get raw dump of http request and responses to the configured oauth provider logged to stdout.

Documentation

Index

• type Module
  • func (m *Module) Configure(injector *dingo.Injector)
  • func (*Module) CueConfig() string
  • func (*Module) Depends() []dingo.Module
  • func (*Module) FlamingoLegacyConfigAlias() map[string]string
  • func (m *Module) Inject(cfg ...) *Module

Types

type Module

type Module struct {
	// contains filtered or unexported fields
}

Module for core.auth Deprecated: use core/auth instead

func (*Module) Configure

func (m *Module) Configure(injector *dingo.Injector)

Configure core.auth module

func (*Module) CueConfig

func (*Module) CueConfig() string

CueConfig for oauth module

func (*Module) Depends

func (*Module) Depends() []dingo.Module

Depends on the session module

func (*Module) FlamingoLegacyConfigAlias

func (*Module) FlamingoLegacyConfigAlias() map[string]string

FlamingoLegacyConfigAlias mapping for backwards compatibility

func (*Module) Inject

func (m *Module) Inject(
	cfg *struct {
		UseFake                     bool   `inject:"config:core.oauth.useFake"`
		PreventSimultaneousSessions bool   `inject:"config:core.oauth.preventSimultaneousSessions"`
		SessionBackend              string `inject:"config:flamingo.session.backend"`
		CheckAuthServer             bool   `inject:"config:core.oauth.healthcheck,optional"`
	},
) *Module

Inject dependencies