Specifiche delle chiavi API utente

[Discourse]

Discourse contiene un sistema per la generazione di chiavi API per utente se si segue un protocollo molto specifico. Questa funzionalità facilita l’accesso tramite “applicazione” alle istanze di Discourse senza dover coinvolgere i moderatori.

Descrizione di alto livello

A un alto livello:

1. Il client (app desktop, plugin browser, app mobile) genera una coppia di chiavi privata/pubblica e un URL di ritorno.

2. Il client reindirizza a una rotta su Discourse fornendo a Discourse la sua chiave pubblica.

3. Discourse ottiene l’approvazione dall’utente per utilizzare l’app.

4. Discourse genera una chiave API utente.

5. Discourse reindirizza all’URL di ritorno con un payload crittografato utilizzando la chiave pubblica contenente la chiave API utente.

Dettagli

Casi d’uso:

1. Applicazioni desktop che interrogano i siti Discourse per conto degli utenti finali per ottenere i conteggi delle notifiche su più siti.

2. Applicazioni mobili che interrogano i siti Discourse per conto degli utenti finali e gestiscono le notifiche push.

3. Applicazioni web che forniscono una dashboard per gli utenti finali su vari siti Discourse.

4. Integrazioni personalizzate con app di terze parti che consumano Discourse come parte di un’app aziendale generale. Es: integrare le notifiche della community di Discourse nell’app hopscotch.

La progettazione:

Impostazioni del sito

• allow_user_api_key_scopes: ambiti di accesso consentiti per le chiavi API utente. Gli ambiti sono definiti qui. Gli ambiti predefiniti disponibili sono: read, write, message_bus, push, one_time_password, notifications, session_info, bookmarks_calendar, user_status (i plugin possono registrare ambiti aggiuntivi).

• user_api_key_allowed_groups: controlla quali gruppi sono autorizzati a generare chiavi API utente (per impostazione predefinita amministratori, moderatori e trust_level_0)

• allowed_user_api_push_urls: elenco di siti che possono essere destinazioni per le notifiche push.

• allowed_user_api_auth_redirects: destinazioni di reindirizzamento consentite dopo la generazione della chiave API utente.

Impostazioni globali

• max_user_api_reqs_per_minute: 20
• max_user_api_reqs_per_day: 2880

Elementi UX

Se sono state concesse chiavi API utente, Discourse visualizza una scheda app nella pagina utente.

La scheda app elencherà:

• Il nome dell’applicazione, ad esempio: (“Discourse Notifier”)
• Ultimo utilizzo
• Data di approvazione
• Elenco degli ambiti di accesso concessi
• Un pulsante revoca accesso in modo da poter revocare facilmente eventuali chiavi.

UI di autorizzazione della chiave API

Ogni chiave dovrà essere esplicitamente autorizzata dagli utenti finali in una pagina che spiega chiaramente cosa sta succedendo, ad esempio:

“Discourse Notifier” sta richiedendo il seguente accesso al tuo account:

• Leggi e cancella notifiche
• Leggi informazioni sulla sessione utente
• Crea un token di accesso una tantum

[Autorizza]

Flusso di generazione della chiave API

L’API richiede un’unica richiesta GET dal lato utente.

https://sitename.com/user-api-key/new

A partire da Discourse 2.1, queste chiavi API utente ora scadono automaticamente se non utilizzate per lunghi periodi di tempo. L’impostazione del sito: revoke user api keys unused days è impostata su 180 di default.

Parametri:

• auth_redirect: URL a cui reindirizzare con il token generato.
• application_name: il nome dell’applicazione che effettua la richiesta (verrà visualizzato nella scheda App dell’account utente).
• client_id: un identificatore univoco per il client.
• nonce: un nonce univoco generato dal client. Questo verrà riportato nel payload crittografato in modo che il client possa verificare l’autenticità della risposta.
• scopes: elenco separato da virgole degli ambiti di accesso consentiti per la chiave; vedere allow user api key scopes per l’elenco completo degli ambiti disponibili.
• push_url: URL a cui inviare le notifiche push (richiesto e valido solo se push o notifications sono inclusi negli ambiti).
• public_key: la parte pubblica della coppia di chiavi generata dal client.
• padding (opzionale): la modalità di padding RSA da utilizzare per la crittografia del payload. I valori accettati sono pkcs1 (default) o oaep. OAEP è raccomandato per le nuove applicazioni.

Dopo che /user-api-key/new è stato chiamato con i parametri corretti, possono accadere 2 cose:

1. Se l’utente non ha effettuato l’accesso, reindirizzeremo al login (dopo il login riprenderemo l’autorizzazione).
2. Una volta che un utente ha effettuato l’accesso, gli verrà presentata l’UI di autorizzazione.

Dopo che l’autorizzazione è stata consentita, il sistema reindirizzerà all’URL definito in auth_redirect e includerà un parametro payload crittografato contenente un oggetto JSON con la chiave API utente generata (key), il nonce, lo stato push (push) e la versione API (api). Se è stato richiesto l’ambito one_time_password, verrà incluso anche un parametro di query oneTimePassword crittografato separato. client_id non viene riportato per maggiore sicurezza.

Controllo della versione API

L’API per l’utilizzo della chiave in Discourse è versionata. I client possono controllare la versione dell’API di un sito Discourse effettuando una richiesta HEAD a https://sitename.com/user-api-key/new. La risposta conterrà un’intestazione denominata Auth-Api-Version contenente il numero di versione dell’API del sito.

Utilizzo dell’API

L’utilizzo dell’API client sarà in qualche modo diverso dall’attuale API di amministrazione.

Il client può specificare 2 intestazioni:

User-Api-Key (richiesto): la chiave che è stata generata

e

User-Api-Client-Id (opzionale): fornire questo per aggiornare l’ID client memorizzato per questa api_key nel database.

Una volta specificate queste intestazioni, il client può eseguire richieste contro l’API proprio come farebbe normalmente.

Generazione di una password di accesso una tantum

A partire dalla versione 4, l’API include un ambito speciale: l’ambito one_time_password, che consente ai client di utilizzare la chiave API utente per generare una password una tantum. Se il client include questo ambito durante la generazione della chiave API seguendo i passaggi precedenti, una oneTimePassword crittografata verrà inclusa come parametro di query separato nel reindirizzamento al client.

In alternativa, il client può effettuare una richiesta GET a /user-api-key/otp con i seguenti parametri:

• auth_redirect
• application_name
• public_key
• padding (opzionale)

e con l’intestazione User-Api-Key.

Questa richiesta reindirizzerà a una schermata in Discourse che chiederà all’utente di consentire all’applicazione l’accesso al sito. Se l’utente approva, il sito reindirizzerà all’URL definito in auth_redirect e includerà un parametro oneTimePassword crittografato con una password una tantum che il client può utilizzare per accedere al sito richiedendo https://sitename.com/session/otp/ONE-TIME-PASSWORD. (La password una tantum è valida solo per 10 minuti.)

Revoca delle chiavi API

Per revocare una chiave API, effettuare una richiesta POST con l’intestazione User-Api-Key e nessun parametro a /user-api-key/revoke.

---

Ultima revisione da @SaraDev il 2022-07-13T00:00:00Z

[elijah (Eli the Bearded)]

There are places I’ve strongly considered writing a delayed post tool, so I can compose a bunch of “word of the day” type things to keep going while I’m on vacation. Doing it without proper API access and pretending to be a browser seems somewhat more complicated than on other forum software.

(Just as an example of another use case.)

[sam (Sam Saffron)]

That is a good example, but keep in mind, our default will be only to enable read tokens, not write ones. Site admins will have to opt to allow write tokens.

Completely agree that the _t cookie hacks are a huge problem.

[jesselperry (Jesse Perry)]

Does max_user_api_calls_per_key_day setting apply to admin-created keys at /admin/api?

[sam (Sam Saffron)]

Nope only to user api keys, we can look at adding extra limits for standard Api keys, it is a good safeguard

[sckott]

To be clear, this is not implemented yet, correct?

[RGJ (Richard - Communiteq)]

No, it’s there (for almost 2,5 years now) - Admin - Settings - User API.

[codinghorror (Jeff Atwood)]

As of Discourse 2.1 these user api keys now auto-expire if left unused for long periods of time, correct @sam?

[sam (Sam Saffron)]

Correct the site setting: expire user api keys days is set to 180 out of the box.

[sckott]

@RGJ

No, it’s there (for almost 2,5 years now) - Admin - Settings - User API.

Okay, but you have to have admin access to see that page yes? And as an admin, it seems I can only create 1 key, so can’t create many keys for different users. confused.

[blake (Blake Erickson)]

What are you trying to accomplish? It’s not clear because there is this (user api keys) and regular API tokens (which is what I think you are after) that admins can create for multiple users, but you have to do that from the individual user’s page inside of the admin dashboard by clicking on the “generate” button on the “API Key” field.

[sckott]

Thanks! Yes, “regular API tokens” for users is what i was after. I’m sure I’d seen that a million times, and never realized it was there.

[vsoch (Vanessasaurus)]

Hey everyone I’m not sure if this was resolved? I see that it’s possible to create an “All Users” and (per user) level API token as an admin, but I’m interested in giving a user the power to generate his/her own token. Has there been work done on this? It sounds like the original thread was getting at this idea, and then it was lost. Thanks!

[sam (Sam Saffron)]

Download the mobile App and then add a site, that uses the user api key system you have to follow a very strict workflow, no plans to expose arbitrary generation of keys in user prefs

[vsoch (Vanessasaurus)]

Thank you! I downloaded the app, and then realized that the sites I belong to don’t have this enabled (I’ve been testing on my local machine with the Dockerized discourse). Just to make sure we are talking about the same thing - I’m interested in generating tokens to use just a scoped subset of functions (and not global API keys to do all the things). Is this what you are talking about?

It seems like, given that there is an endpoint to generate tokens, it would be logical to provide this function (to users with a certain trust level, for example) from within the site. Otherwise, it would need to be the case that the site generates some external page (with a server to hide an admin token) to generate the keys for the user. Is it the case that 1. there is no internal generation of tokens for the user (and why not?) and 2. Nobody has created some external app (javascript, flask, anything really) to perform this action?

[sam (Sam Saffron)]

@vsoch

Is this what you are talking about?

Yes.

@vsoch

it would be logical to provide this function (to users with a certain trust level, for example) from within the site. Otherwise, it would need to be the case that the site generates some external page (with a server to hide an admin token) to generate the keys for the user. Is it the case that 1. there is no internal generation of tokens for the user (and why not?) and 2. Nobody has created some external app (javascript, flask, anything really) to perform this action?

Possibly, conceptually

1. This is tricky to consume cause you need to use custom HTTP headers (by design)

2. It would be very hard to educate even TL3 users about what the point is of this thing.

I prefer not to ship UI for this in core, but maybe you should write a plugin for your specific use case?

Can you explain a bit more about the “why” here?

The design of the system centers around “I have an external dedicated program”, “this program knows how to follow Discourse protocol”, “It asks for token”

API keys (non user ones) are much easier to consume cause you just append them after the ?

[ymi]

@sam

Consuming the API

Consuming the client API will be somewhat different that the current admin API.

Client can specify 2 headers:

User-Api-Key (required): the key that was generated

and

User-Api-Client-Id (optional): supply this to update the ‘client id’ stored for this api_key in the database.

Once those headers are specified client can perform requests against the API just as they would normally.

Can I pass the API key generated from the user page on this? I was trying to use that API key and seeing ‘You are not permitted to view the requested resource.’ error on /categories.json API request

[Alan_Murphy]

Hi guys

Apologies if this is duplication but I am having trouble digesting the steps there even though they are very well put together

I have a discourse installation on https://forum.domain.com and a site on https://development.domain.com from which I need to make calls to the discourse installation to pull and set some data.

All requests work from postman with Api-Username and Api-Key - no problem

However for cross origin requests using JS discourse doesnt allow the Api-Username leading me down the path of the flow described in this thread i.e. using the User-Api-Key and the User-Api-Client-Id

I basically require a description of paramaters PUBLIC_KEY,NONCE,CLIENTID used in the sample request below and where I can get them…

https://forum.domain.com/user-api-key/new?public_key=PUBLIC_KEY&nonce=NONCE&scopes=SCOPES&client_id=CLIENTID&application_name=DEVELOP&auth_redirect=XXX

Finally will this flow allow for seamless api requests from my https://development.domain.com to https://forum.domain.com without the need for authentication.

PS I have SSO set up between the forum and the site from which the requests are being made so the user will be logged in…

Thanks for any guidance

[sam (Sam Saffron)]

One sec, is this a per user thing? Are you allowing arbitrary users to do this?

Our server API supports header based auth these days so it can work with CORS just like the user api keys do. You would use the user api keys if you want to restrict scopes and allow end users to generate the keys vs admins.

[Alan_Murphy]

I wouldn’t see each user requiring a separate key no… One admin key should do what I need.

I can consume the api no problem through postman. For example a GET to /notifications.json?username=alanmurphy returns the data no problem using just api-key as a header.

If I trigger that request from the console of a discourse installation I get data back no problem also i.e.

var xhr = new XMLHttpRequest();
xhr.addEventListener(“readystatechange”, function () {
if (this.readyState === 4) {
console.log(this.responseText);
}
});
xhr.open(“GET”, “https://**********.com/notifications.json?username=alanmurphy”);
xhr.setRequestHeader(“api-key”, “d06ca53322d1fbaf383a6394d6c229e56871342d2cad953a0fe26c19df7645ba”);
xhr.setRequestHeader(“api-userame”, “system”);
xhr.send();

All Good:+1:

However, if I do this from the sub-domain I am wishing to contact discourse from, it tells me that it has been blocked by CORS policy: Request header field api-key is not allowed by Access-Control-Allow-Headers.

The allowed headers are:

Content-Type, Cache-Control, X-Requested-With, X-CSRF-Token, Discourse-Visible, User-Api-Key, User-Api-Client-Id

If I could just get guidance on what auth params to pass for cross origin requests and where to get them that would be very helpful.

Ps. My discourse is set up to allow Cross Origin requests from the domain so I believe it is purely a headers issue

Thanks