com.amarjanica.discourse.util

SSOProvider

class SSOProvider extends AnyRef

Helper class for providing single sign on integration with Discourse.

How the SSO works:

1. User clicks "Login" on your site while your site has sso enabled.

2. User is redirected to the link you have provided in the Discourse SSO settings. Using SSOProvider, you verify the incoming SSO request(via the configured SSO secret), then you authenticate the user that is trying to log in(by letting them log in to your system or by using their existing session in your system).

3. You get the user information for the authenticated user, and use SSOProvider to build a query string that will be sent back to discourse/session/sso_login

For example:

val ctx: SSOContext = ???
val req: SSOUserRequest = ???
val sso = new SSOProvider(ctx).generate(req)
val discourseSite = "http://discourse.example.com"
// use redirectUrl to authenticate to your discourseSite
val redirectUrl = s"${discourseSite}/session/sso_login?sso=${sso.payload}&sig=${sso.signature}"
See also

Discourse for more information

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SSOProvider
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SSOProvider(ctx: SSOContext)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from SSOProvider to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (SSOProvider, B)

    Implicit information
    This member is added by an implicit conversion from SSOProvider to ArrowAssoc[SSOProvider] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def ensuring(cond: (SSOProvider) ⇒ Boolean, msg: ⇒ Any): SSOProvider

    Implicit information
    This member is added by an implicit conversion from SSOProvider to Ensuring[SSOProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (SSOProvider) ⇒ Boolean): SSOProvider

    Implicit information
    This member is added by an implicit conversion from SSOProvider to Ensuring[SSOProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): SSOProvider

    Implicit information
    This member is added by an implicit conversion from SSOProvider to Ensuring[SSOProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): SSOProvider

    Implicit information
    This member is added by an implicit conversion from SSOProvider to Ensuring[SSOProvider] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from SSOProvider to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Definition Classes
    AnyRef
  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  24. def provide(req: SSOUserRequest): SSOUserResult

  25. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  26. def toString(): String

    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (SSOProvider, B)

    Implicit information
    This member is added by an implicit conversion from SSOProvider to ArrowAssoc[SSOProvider] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from SSOProvider to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sSOProvider: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from SSOProvider to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sSOProvider: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: SSOProvider

    Implicit information
    This member is added by an implicit conversion from SSOProvider to ArrowAssoc[SSOProvider] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sSOProvider: ArrowAssoc[SSOProvider]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: SSOProvider

    Implicit information
    This member is added by an implicit conversion from SSOProvider to Ensuring[SSOProvider] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (sSOProvider: Ensuring[SSOProvider]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from SSOProvider to StringAdd

Inherited by implicit conversion any2stringfmt from SSOProvider to StringFormat

Inherited by implicit conversion any2ArrowAssoc from SSOProvider to ArrowAssoc[SSOProvider]

Inherited by implicit conversion any2Ensuring from SSOProvider to Ensuring[SSOProvider]

Ungrouped