Use OAuth 2.0 to obtain pinning service access token

Đang mở
#1,879 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
javascript, react
Lĩnh vực
api, authentication, frontend

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra cấu hình pinning-service hiện có và tích hợp Pinata trong WebUI; issue không nêu tên các tệp hoặc bài kiểm thử cụ thể. Xác định client ID, callback page, scopes, các authorization endpoint và token endpoint của provider, cũng như entry point của settings page. Được xem là hoàn tất khi một luồng OAuth của Pinata được tài liệu hóa quay lại WebUI và cấu hình provider, đồng thời các yêu cầu đăng ký phía provider cũng được tài liệu hóa.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
JavaScript
Star
1.6k
Fork
539
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của ipfs/ipfs-webui

Tất cả issue của ipfs/ipfs-webui

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.