Use OAuth 2.0 to obtain pinning service access token
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Nueva funcionalidad
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript, react
- Área
- api, authentication, frontend
Línea de trabajo
Comienza examinando la configuración existente del servicio de pinning y la integración de Pinata en la WebUI; el issue no nombra archivos ni tests específicos. Define el ID de cliente, la página de callback, los scopes, los endpoints de autorización y de token del proveedor, y el punto de entrada de la página de configuración. Se considera terminado cuando un flujo OAuth de Pinata documentado vuelve a la WebUI y configura el proveedor, con los requisitos de registro del lado del proveedor documentados.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Current situation
At the moment, configuring a pinning service requires a few manual steps:
- Accessing the pinning provider (e.g. Pinata)
- Creating an access token on the API Key management UI of the provider
- Figuring out the desired scope of actions the key should allow
- Pasting the access token on the client (IPFS WebUI settings page)
While the experience is already quite simple for the current IPFS audience, it could be improved for lazy and/or less technical users, in line with the purpose of IPFS WebUI.
Possible improvement: OAuth 2.0 authorization flow
User experience
With Pinata for instance, the UX would be:
- From WebUI, I click on Pinata icon. I'm directed to Pinata's consent page, showing IPFS WebUI logo and name, as well as the desired scope (around the lines of "Manage pinning").
- I click on "Authorize".
- Et voilà. I'm back to my WebUI instance and the provider is configured.
Technical changes
- Decide on (and document) a client_id constant, say
ipfs_webui. - Implement (and document) a callback page that receives the OAuth 2.0 response after the user has granted access, and does the token fetching logic. There are libraries that help greatly with that bit.
- Define (and document) one or several scopes based on consent granularity. I'm not familiar with the feature enough yet, but one scope might be enough at first, e.g.
pinning. - Add a clickable button to send the user to the provider's authorization endpoint, with the proper client_id, redirect_uri and scope (the same libraries can generate that link too).
- Currently that would be only for Pinata but the process would be identical for any provider, changing only the endpoints, or even only the base hostname thanks to RFC 8414 and/or OIDC Discovery.
- Possibly also an input box for configuring custom providers.
For reference, on the provider side:
- Expose OAuth 2.0 endpoints (namely the authorization endpoint and the token endpoint).
- Make the token endpoint automatically generate an API key with the right permissions (taken from the scope).
- Register IPFS WebUI as a public client, with logo and name, and the documented client_id and callback URI.
Additional notes
A similar approach would exist for other clients such as Desktop UI, CLI etc., with different callback URIs (native deep link etc.).
- Lenguaje dominante
- JavaScript
- Estrellas
- 1.6k
- Forks
- 539
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de ipfs/ipfs-webui
-
need/triage
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
ipfs/ipfs-webui#2454 ·
-
Stories anonymous objectAbiertoneed/triage
Dificultad 1/5 Menos de una hora Aptitud para principiantes 45/100
ipfs/ipfs-webui#2391 · 3 comentarios ·
-
effort/days exp/intermediate help wanted P2 status/blocked
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
ipfs/ipfs-webui#2380 · 6 comentarios · 1 reacción ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 28/100
ipfs/ipfs-webui#2359 · 3 comentarios · 1 reacción ·
-
feat: create shortcut component that can be used on any pagePosiblemente ocupada @george-hub331 la tomó hace 588 días. AbiertoP3
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
ipfs/ipfs-webui#2350 · 2 comentarios ·
Todos los issues de ipfs/ipfs-webui
Issues similares
-
chore cloudflare-workers consistency d1 difficulty: easy documentation dx enhancement good first issue help wanted hygiene javascript maintenance priority: P3 seo
Dificultad 1/5 Menos de una hora Aptitud para principiantes 75/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día
-
Link Checker ReportAbiertoautomated issue report
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
MattiaPARRINELLO/backstage#70 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
untemps/svelte-palette#298 ·