@3fv/atlassian-oauth-connect 中文文档教程

Question

Atlassian OAuth 2 (3LO) Browser/Server Client

Install

这是一个正确配置的混合模块， 所以 commonjs & module/esm 运行时是 支持，这意味着 browser & node 环境可以让你整个 不包括 decode 功能的库， 我最终会转换为浏览器支持 使用 cryptojs，但它的功能是透明的 现在在任何环境中

yarn add @3fv/atlassian-oauth-connect

Example Implementation (not for prod use)

Prequistes

首先，确保您已经通过您选择的包管理器 brew、apt、pacman< 安装了 direnv /code> 等...

Setup

将 .envrc.templace 复制到 .envrc 并填写所有缺失的字段。 此外，范围列表健壮，但目的是 显示每个当前可用的范围，所以，继续 将其与您需要的配对。

使用您在Atlassian Developer Console 配置您的应用程序时输入/收到的值填充您的重定向 URI、客户端 ID 和客户端密码

警告：如前所述，这只是一个示例； 在现实世界的场景中，配置将来自另一个系统，如 AWS AppConfig，具有适当的秘密管理等。

首先，复制文件：cp .envrc.template .envrc

接下来，从上述 Atlassian Developer Console 应用注册中填充您应用的值。

# IN CASE YOUR SHELL DOESN'T DO THIS FOR YOU
PATH_add $PWD/node_modules/.bin

# SCOPES FOR AUTHORIZATION.
# THEY MUST BE SPACE DELIMITED
export ATLASSIAN_SCOPE="\
  read:me \
  offline_access \
  read:jira-user \
  read:jira-work \
  write:jira-work \
  manage:jira-project \
  manage:jira-configuration \
  manage:jira-webhook \
  read:confluence-content.all \
  read:confluence-content.summary \
  write:confluence-content \
  write:confluence-space \
  write:confluence-file \
  read:confluence-props \
  write:confluence-props \
  manage:confluence-project \
  manage:confluence-configuration \
  search:confluence"

# APP REGISTRATION DETAILS
export ATLASSIAN_REDIRECT_URI=<YOUR_ATLASSIAN_REDIRECT_URI>
export ATLASSIAN_CLIENT_ID=<YOUR_ATLASSIAN_CLIENT_ID>
export ATLASSIAN_CLIENT_SECRET=<YOUR_ATLASSIAN_CLIENT_SECRET>

Run the example

示例服务器是一个非常基本的 html 页面和 express web 服务器，它们一起作为一个相当完整的工具用于 测试与 验证 atlassian 连接集成。

来源在这里 ./src/example/server.ts & ./src/example/index.html

# Install Deps
yarn

# Build & Run Example Server
yarn example:server:start

现在你可以打开浏览器到 http://localhost:4000 玩玩

Hackup to play with Atlassian Connect

我想如果这不容易，你可能会生气， 所以它都是脚本化

的以监视模式启动打字稿编译器 和服务器通过 nodemon，只需运行以下

yarn run example:server:dev

Features

• getAccessibleResources() queries for all resources (projects & spaces) for which a user accepted grants. Here's an example response.

[
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "https://3fv.atlassian.net",
    "name": "3fv",
    "scopes": [
      "manage:confluence-configuration",
      "search:confluence",
      "write:confluence-props",
      "read:confluence-props",
      "write:confluence-file",
      "write:confluence-space",
      "write:confluence-content",
      "read:confluence-content.summary",
      "read:confluence-content.all"
    ],
    "avatarUrl": "https://site-admin-avatar-cdn.prod.public.atl-paas.net/avatars/240/triangle.png"
  },
  {
    "id": "00000000-0000-0000-0000-000000000000",
    "url": "https://3fv.atlassian.net",
    "name": "3fv",
    "scopes": [
      "manage:jira-configuration",
      "manage:jira-project",
      "manage:jira-webhook",
      "write:jira-work",
      "read:jira-work",
      "read:jira-user"
    ],
    "avatarUrl": "https://site-admin-avatar-cdn.prod.public.atl-paas.net/avatars/240/triangle.png"
  }
]

• retrieveAccessToken() 代码到令牌交换

• getUserProfile( ) 检索当前用户配置文件。

{
  "account_id": "0000000000000",
  "email": "aaaa@bbbbbbbb.com",
  "name": "Jonathan Glanz",
  "picture": "https://secure.gravatar.com/avatar/...",
  "account_status": "active",
  "last_updated": "2021-11-15T14:49:38.747Z",
  "nickname": "Jonathan Glanz",
  "locale": "en-US",
  "extended_profile": {
    "job_title": "Software Engineer",
    "team_type": "Software Development"
  },
  "account_type": "atlassian",
  "email_verified": true
}

• Token refresh rolling functionality; all the requirements to implement refresh token rolling, including the actual refresh token (if you specified the offline_access scope) & the expiration data, so you can implement your own refresh token rolling or wait for me to find a reason :grin:

Todo

• [ ] Signature Verification (OOB the atlassian-jwt package chucks errors when verifying the returned tokens)
• [ ] Caching, right now, if you call getUserProfile, retrieveAccessToken, etc., every call no matter identical params or not, query the endpoints; so this is kind of important
• [ ] Unit tests would be a good idea (started & configured, just not implemented :smile:)
• [ ] Plus a few e2e cypress tests (started)

Credit

由 @jglanz 3FV 在#NYC 用爱写成。 享受