Discourse als Identitätsanbieter nutzen (SSO, DiscourseConnect)

[Discourse]

Möchten Sie Discourse als Identitätsanbieter für Ihre eigene Web-App verwenden? Großartig! Lassen Sie uns beginnen.

DiscourseConnect-Anbietereinstellung aktivieren

Aktivieren Sie unter den Website-Einstellungen der Discourse-Administration (/admin/site_settings) die Einstellung enable discourse connect provider und fügen Sie einen geheimen String zu discourse connect provider secrets hinzu (wird zum Hashen von SSO-Payloads verwendet).

Implementieren Sie DiscourseConnect in Ihrer Web-App:

• Generieren Sie eine zufällige Nonce. Nennen wir diesen Wert NONCE. Speichern Sie ihn vorübergehend, damit Sie ihn mit dem Wert der Nonce, der in der Antwort zurückgegeben wird, verifizieren können.

• Erstellen Sie eine neue Payload mit der NONCE und einer RETURN_URL (zu der Discourse den Benutzer nach der Verifizierung weiterleitet). Die Payload sollte so aussehen: nonce=NONCE&return_sso_url=RETURN_URL. Der Host der RETURN_URL muss mit dem Domain-Muster übereinstimmen, das Sie bei der Konfiguration von discourse connect provider secrets verwendet haben.

• Base64-codieren Sie die obige Roh-Payload. Nennen wir diese Payload BASE64_PAYLOAD.

• URL-codieren Sie die obige BASE64_PAYLOAD. Nennen wir diese Payload URL_ENCODED_PAYLOAD.

• Generieren Sie eine HMAC-SHA256-Signatur aus der BASE64_PAYLOAD unter Verwendung Ihres SSO-Anbietergeheimnisses als Schlüssel, und erstellen Sie daraus anschließend einen Hex-String in Kleinbuchstaben. Nennen wir diese Signatur HEX_SIGNATURE.

Senden Sie eine Authentifizierungsanforderung an Discourse

Leiten Sie den Benutzer zu DISCOURSE_ROOT_URL/session/sso_provider?sso=URL_ENCODED_PAYLOAD&sig=HEX_SIGNATURE weiter.

Erhalten Sie die Antwort von Discourse:

Wenn die obigen Schritte korrekt ausgeführt wurden, leitet Discourse den angemeldeten Benutzer zur angegebenen RETURN_URL weiter. Sie erhalten Abfrageparameter mit sig und sso sowie einige Benutzerinformationen. Führen Sie nun die folgenden Schritte aus:

• Berechnen Sie das HMAC-SHA256 von sso unter Verwendung des SSO-Anbietergeheimnisses als Schlüssel.

• Wandeln Sie sig von seiner Hex-String-Darstellung zurück in Bytes um.

• Stellen Sie sicher, dass die beiden obigen Werte übereinstimmen.

• Base64-dekodieren Sie sso; Sie erhalten die übergebene eingebettete Abfragezeichenfolge. Diese enthält einen Schlüssel namens nonce, dessen Wert mit der ursprünglich übergebenen Nonce übereinstimmen sollte. Stellen Sie sicher, dass dies der Fall ist, und löschen Sie die Nonce unbedingt aus Ihrem System.

• Sie werden feststellen, dass diese Abfragezeichenfolge auch eine Reihe von Benutzerinformationen enthält. Verwenden Sie diese nach Belieben.

Das ist alles. Bis dahin sollten Sie Ihre Web-App so eingerichtet haben, dass sie Discourse als SSO-Anbieter verwendet!

Mehr Parameter, Mehr Optionen

Zusätzlich zu nonce und return_sso_url enthält die Anforderungs-Payload mehrere optionale zusätzliche Parameter.

• prompt: Wenn prompt=none, wird die SSO-Anforderung als „nur prüfen“-Anforderung behandelt. Wenn der Browser/das Gerät bereits bei Discourse angemeldet ist, gibt Discourse wie gewohnt eine erfolgreiche SSO-Antwort mit Benutzerauthentifizierungsinformationen zurück. Wenn der Browser/das Gerät nicht angemeldet ist, fragt Discourse den Benutzer nicht nach der Anmeldung und gibt stattdessen sofort eine SSO-Antwort mit dem Parameter failed=true anstelle von Benutzerinformationen zurück. Dies bietet einen Mechanismus, um abzufragen, ob der Benutzer angemeldet ist, ohne den Benutzer jemals zu einem Anmeldedialog weiterzuleiten, falls er nicht angemeldet ist.

• logout: Wenn logout=true, wird die SSO-Anforderung zu einer Abmeldeanforderung. Wenn ein Benutzer auf diesem Browser/Gerät bei Discourse angemeldet ist, wird er von diesem Gerät abgemeldet. In jedem Fall leitet Discourse sofort zurück zur return_sso_url weiter, ohne dass sso oder sig der Abfragezeichenfolge hinzugefügt werden.

• require_2fa: Wenn require_2fa=true, verlangt Discourse vom Benutzer die Überprüfung der Zwei-Faktor-Authentifizierung, bevor er zurückgeleitet wird. Die Antwort-Payload enthält confirmed_2fa=true, wenn der Benutzer die 2FA-Überprüfung erfolgreich abgeschlossen hat, oder no_2fa_methods=true, wenn der Benutzer keine 2FA-Methoden konfiguriert hat.

prompt=none und logout=true sind gegenseitig ausschließend; es ergibt keinen Sinn, beide in derselben Anforderung anzugeben.

sso= Payload-Referenz

Anforderungsparameter:

• nonce: (String, erforderlich) eine sicher generierte zufällige Zeichenfolge
• return_sso_url: (String, erforderlich) die URL, zu der mit der Antwort zurückgeleitet werden soll
• prompt: (String, optional) Wenn none, wird der Authentifizierungsstatus ohne Aufforderung zur Anmeldung beim Benutzer abgefragt.
• logout: (Boolean, Standard false) Wenn true, wird der Benutzer von Discourse abgemeldet.
• require_2fa: (Boolean, Standard false) Wenn true, muss der Benutzer die Zwei-Faktor-Authentifizierung überprüfen, bevor er zurückgeleitet wird.

Ergebnisp-Parameter:

• Es gibt keine sso=-Payload oder Signatur als Antwort auf eine Abmeldeanforderung, nur eine Weiterleitung zur einfachen return_sso_url der Anforderung.

• Die Ergebnis-Payload für eine Anmeldeanforderung enthält immer die nonce, die von der Anforderung reflektiert wird.

• Die Ergebnis-Payload spiegelt auch alle anderen Anforderungsparameter wider. Verlassen Sie sich nicht auf dieses Verhalten; es ist nicht unbedingt beabsichtigt und kein garantierter Aspekt der API. (Warum wird beispielsweise der Parameter return_sso_url in die Payload kopiert, die an die return_sso_url gesendet wird?)

• Wenn die Anforderung die Authentifizierung eines Benutzers fehlgeschlagen hat, enthält die Ergebnis-Payload failed=true.

• Wenn die Anforderung die Authentifizierung eines Benutzers erfolgreich abgeschlossen hat, enthält die Ergebnis-Payload Anmelde-/Benutzerinformationen:

  • external_id: (String) Discourse Benutzer-ID
  • username: (String) Benutzername/Handle
  • name: (String) Name des Benutzers
  • email: (String) E-Mail-Adresse
  • avatar_url: (String) vollständige CDN-URL des hochgeladenen Avatarbilds des Benutzers
  • admin: (Boolean) true, wenn der Benutzer ein Administrator ist, andernfalls false
  • moderator: (Boolean) true, wenn der Benutzer ein Moderator ist, andernfalls false
  • groups: (String) durch Kommas getrennte Liste von Gruppen (nach Name), zu denen der Benutzer gehört
  • profile_background_url: (String) vollständige CDN-URL des Profilhintergrundbilds des Benutzers
  • card_background_url: (String) vollständige CDN-URL des Kartenhintergrundbilds des Benutzers
  • confirmed_2fa: (Boolean) true, wenn der Benutzer die 2FA-Überprüfung abgeschlossen hat (nur vorhanden, wenn require_2fa=true angefordert wurde)
  • no_2fa_methods: (Boolean) true, wenn der Benutzer keine 2FA-Methoden konfiguriert hat (nur vorhanden, wenn require_2fa=true angefordert wurde)

  name, avatar_url, profile_background_url und card_background_url können fehlen, wenn der Benutzer diese nicht festgelegt hat. (Jedes Element mit einem nil-Wert innerhalb von Discourse wird aus der Antwort weggelassen.)

Offizielle „Verwendung von Discourse als Identitätsanbieter“-Implementierungen von Discourse:

• Ein HTTP-Proxy (mit Golang), der Discourse SSO zur Authentifizierung von Benutzern verwendet (nur Admins): GitHub - discourse/discourse-auth-proxy: An http proxy that uses the DiscourseConnect protocol to authenticate users · GitHub (erstellt von @sam)

Von der Community beigesteuerte Implementierungen zur „Verwendung von Discourse als SSO-Anbieter“:

• Ein PHP-Skript, das Discourse als SSO-Anbieter implementiert: Discourse sso provider login · GitHub (erstellt von @paxmanchris)

• Ruby:
  GitHub - AstonJ/sso_with_discourse: Implementation in ruby for https://meta.discourse.org/t/using-discourse-as-a-sso-provider/32974 · GitHub

• Erlang:
  https://github.com/reverendpaco/discourse-as-sso-erlang

• Node.js:
  GitHub - edhemphill/passport-discourse: A Passport strategy for authenticating using a Discourse forum · GitHub
  GitHub - ArmedGuy/discourse_sso_node: npm package for Discourse SSO login features. · GitHub

• ASP.NET Core (erfordert nur Konfiguration):
  GitHub - Biarity/DiscourseSso: Easy, configurable Discourse SSO: GET /auth/login -> recieve a JWT with user data · GitHub

• MediaWiki-Erweiterung (PHP):
  DiscourseSsoConsumer, a SSO extension for MediaWiki (erstellt von @mdoggydog)

[jamesmarkcook (James Cook)]

Great how to, thanks.

FYI, the term ‘nonce’ has an unfortunate meaning in Britain.

[gogo52cn (david)]

I wrote a class to implement the process in Ruby. I use it to work with devise in my web application.

https://github.com/gogo52cn/sso_with_discourse

[ianmackinnon]

@techAPJ

Compute the HMAC-SHA256 of sso using sso_secret as your key.

sso seems to have a trailing newline which needs to be included when sent to the HMAC function, so it’s important to make sure that SSO consumer applications don’t strip whitespace from these query arguments.

[geneles (Michael Geneles)]

Our app users get their own subdomains. Is there a way to implement this with variable SSO urls?

[sam (Sam Saffron)]

interesting, this is tricky you would need to monkey patch this in, or better still make core extensible in this way and add a plugin.

[reverend_paco (Daniel Eklund)]

Hello,

I have created an Erlang implementation for encoding/decoding the payloads described in this specification. You can find it here:
https://github.com/reverendpaco/discourse-as-sso-erlang
Feedback is welcome.

Thanks to @mpalmer on another thread for setting me straight.

As I put together this implementation, I realized that the specification does not say too much about a few things:

1. the user information that is returned in the query parameters,
2. what happens when a user is not found

When I got around to testing I found the answers, and then confirmed by looking at the code, here: discourse/app/controllers/session_controller.rb at main · discourse/discourse · GitHub

I shall assume that in regards to 1. that while new user information may be added, that none of these values (“name”,“username”,“email”,“external_id”, etc) will be removed. This is just as important, contractually as what is described in the main post.

One piece of feedback I’d like to give the Discourse team is that it would be nice to add a means to optionally return back to the calling application in the case of a missing user.

Currently, at line 51 a non-logged-in or non-registered user will be forwarded to the Discourse login page. While this can be useful, I would rather programmatically have the option to learn that this person has not yet logged in (or registered) and give them the opportunity on my site to continue anonymously.

I can imagine something like this:

DISCOURSE_ROOT_URL/session/sso_provider?
sso=URL_ENCODED_PAYLOAD&sig=HEX_SIGNATURE&
returnBackIfUserMissing=true

and then the Discourse site sending back to the return_sso_url with either a special header, or an attribute, rather than redirecting to /login.

This change should be backwards compatible.
I’m new here, so if this is something that could be contributed via a pull-request, please tell me and I could take a shot at it next week.

thanks,
daniel

[sam (Sam Saffron)]

@reverend_paco

One piece of feedback I’d like to give the Discourse team is that it would be nice to add a means to optionally return back to the calling application in the case of a missing user.

Sure, totally open to add another option to the payload you send us for create_new=false PR welcome.

[reverend_paco (Daniel Eklund)]

added a PR for this

Optional 'no_user_found_return_sso_url' parameter for using Discourse as SSO

Commit-Message:

Implemented an optional 'no_user_found_return_sso_url' parameter to be called
 by the client when client is using Discourse as an SSO and wants Discourse to 
redirect back to a place of the client's choosng when a user is not found.

Currently, the Discourse as an SSO implementation checks the cookies _t and
 _session_forum to see if the user is registered and present in the database 
(_t is the token that is located in the users table). If a user is not found, 
the current implemenation forwards to the forum's /login URL. This behavior 
may be what the client wants, but it would be good to give an option to the 
client to send somewhere else.

This commit allows the client to embed an optional 'no_user_found_return_sso_url' 
parameter in the payload, prior to base64 and URL-encoding. If the Discoure SSO
endpoint detects that this parameter is present in the payload (and has a non-empty
value) the Discourse server will redirect to this new location if it does not detect the 
user. If this parameter is not present, then the redirection to /login will take place 
as it currently does.

Additionally, as the client may choose to use the same URL for
'no_user_found_return_sso_url' as for 'return_url', this commit introduces a new 
query-string name-value pair to be sent back to the client 'no_user_found_return_sso_url' 
location. This parameter 'user_found' will ALWAYS be sent back to the client, either when 
the user is found and 'return_url' is used or when the user is not found 
'no_user_found_return_sso_url' is used (values will be 'true' and 'false' respectively).

thanks,
daniel

[fantasticfears (Erick Guan)]

Nice work

redirect_to can be routed to a url with parameters. But isn’t a create_new=false enough? Or whatever name it is. You’ll get nonce and the flag back.

[reverend_paco (Daniel Eklund)]

@fantasticfears

But isn’t a create_new=false enough? Or whatever name it is. You’ll get nonce and the flag back.

I wanted to give the client the flexibility of sending a failure to a different URL than the success url (return_url). With complicated SSO architectures, this might be a requirement. (Selfishly, I wanted to make my return endpoint code less convoluted – i.e. on my side I have two codebases at /sso for success and /sso_failure for failure).

Implicitly there are already two URLs (return_url for success and ‘/login’ for failure) – I didn’t want to lose that.

So just to be clear, the payload you send to the Discourse endpoint should have both return_url and no_user_found_return_sso_url if you want Discourse to send it back when no user is found. It should have return_url only if you are ok with Discourse forwarding to /login.

Should look like this:

1.If you want Discourse to forward to login if no user found, then:

PAYLOAD = return_url=mydomain.com/clientendpoint&nonce=xE787euK
2. If you want Discourse to send back to you to the same endpoint for failure as success:

PAYLOAD = no_user_found_return_sso_url=mydomain.com/clientendpoint&return_url=mydomain.com/clientendpoint&nonce=xE787euK
3. If you want Discourse to send back to you to a different endpoint as success:

PAYLOAD = no_user_found_return_sso_url=sub.mydomain.com/handleNewUser&return_url=mydomain.com/clientendpoint&nonce=xE787euK

Potentially a bit over-engineered, but that was my thought process.

[fantasticfears (Erick Guan)]

@reverend_paco

I wanted to give the client the flexibility of sending a failure to a different URL than the success url (return_url). With complicated SSO architectures, this might be a requirement. (Selfishly, I wanted to make my return endpoint code less convoluted – i.e. on my side I have two codebases at /sso for success and /sso_failure for failure).

To be clear, it’s not user_not_found, it’s not logged in.

It’s about protocol not engineering in the first place. Given two endpoints, you have to deal with two possible endpoints. In both cases you must validate the nonce and destroy it. It’s a hurdle not benefit.

In extreme case, a client can ask Discourse several times with/without session (current_user), thus you would get n responses in each endpoints. It would be twice as hard to secure it due to changing cookies on your end.

[reverend_paco (Daniel Eklund)]

@fantasticfears

It’s about protocol not engineering in the first place.

Completely agree on protocol over engineering. Hence, my submission.

The semantics are equivalent to an if-else block, or more generally a case/switch block. result_url is our true condition, and user_not_found_url is our else block. If we didn’t provide it, we would force the client to have to deal with the ‘failure’ condition in the same codebase/endpoint – and for 90% of the people, this will be fine.

90% of people who want Discourse to return back to them will set return_url and user_not_found_url to be exact same thing. This bears repeating, and really renders the motivations for the 10% moot.

90% of the time you will make return_url and user_not_found_url the exact same thing. These 90%-ers will use their JSESSIONID/ PHPSESSID/ ASPSESSIONID /_session to look up the returned encoded nonce in their framework-supplied session-store and engineer accordingly.

7% of people will be happy to pass it to a different URL on their same app-server, which does some decoration (servlet-chains anyone?) or routing, but still looks up the nonce in their session.

3% will have some complicated polyglotish system that uses a distributed session store (like memcache) to store sessions for different app servers implemented in different legacy codebases. It’s up to them to store/invalidate the nonce across these different systems.

I realize I might not have been completely clear, but the user_not_found_url still receives the sso and sig parameters, just like the return_url.

So, if you are the 90% scenario, when you get the payload and verify/decode it, you will find the parameter user_found=false|true to know why it’s coming back to you.

[reverend_paco (Daniel Eklund)]

@fantasticfears, as per your recommendation on the PR, I have renamed the attribute from user_not_found_url to return_sso_unlogged_in_url.

[thomasschmit]

Great job !

Do you know how it possible to adapt it to GitLab in order to allow the Discourse users to directly login there?

[edhemphill (Ed)]

Hey folks, I could not find anything, so I created a npm for Discourse auth using Passport for node.js.

It’s here, and in npm if anyone needs it:

GitHub - edhemphill/passport-discourse: A Passport strategy for authenticating using a...

(really appreciate the team’s work, we’ve been a user since the very early days @ talk.wigwag.com)

[reverend_paco (Daniel Eklund)]

@sam,

I have submitted a reply back to your rejection of the PR:
Optional 'no_user_found_return_sso_url' parameter for using Discourse as SSO by reverendpaco · Pull Request #4211 · discourse/discourse · GitHub

As I have been relying on my patched version of discourse for these months, I would be interested in convincing you as to my need.

[reverend_paco (Daniel Eklund)]

@reverend_paco

@sam,

I have submitted a reply back to your rejection of the PR:
Optional 'no_user_found_return_sso_url' parameter for using Discourse as SSO by reverendpaco · Pull Request #4211 · discourse/discourse · GitHub

As I have been relying on my patched version of discourse for these months, I would be interested in convincing you as to my need.

If this PR is going to be rejected, could you explain what I can do to get the functionality that I need?

[Sveinn_S (Sveinn Svavarsson)]

Does anyone know of a wordpress plugin that works with discourse as the SSO provider?