Use OAuth 2.0 to obtain pinning service access token

オープン
#1,879 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
javascript, react

調査の方向性

まず、WebUI における既存の pinning-service 設定と Pinata 統合を調査します。この issue では具体的なファイルやテストは指定されていません。client ID、callback page、scopes、provider の authorization endpoint と token endpoint、および settings page の entry point を定義します。完了条件は、文書化された Pinata OAuth フローが WebUI に戻り、provider を設定できることと、provider 側の登録要件が文書化されていることです。

索引モデルが issue の本文から書いたものです。

説明

effort/weeks help wanted kind/enhancement P3

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.).

主要言語
JavaScript
スター
1.6k
フォーク
539
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

ipfs/ipfs-webui のほかの issue

ipfs/ipfs-webui の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。