# 可用的 Node Modules

目前 Authing Pipeline 中可以使用以下 Node Modules:

# Authing SDK for Node.js

处于安全考虑, Authing 会通过特殊方式,使用你的用户池 ID(userPoolId) 和用户池密钥(secret) 初始化 authing-js-sdk,此过程不会将你的用户池密钥发送到公网。你可以使用使用全局变量 authing请勿再次初始化 SDK!

开发者可以直接使用初始化过后的 authing 实例,无需手动初始化!Authing Pipeline 会自动帮助开发者 take care 初始化过程。

如下所示:

async function pipe(user, context, callback) {
  if (!user.email.endsWith('@authing.cn')) {
    return callback(null, user, context)
  }

  try {
    await authing.authz.addUserToGroup({
      userId: user._id,
      groupId: env.ROOT_GROUP_ID
    })
  } catch (error) { }

  callback(null, user, context)
}

解释一下:

  • 2-4 行判断用户邮箱是否已 @authing.cn 结尾,如果不是,可以直接跳过此 Pipeline 函数。
  • 6-11 行调用 Authing 的基于角色的权限控制(RBAC) API,将请求用户添加至用户组 ROOT_GROUP_ID
    • 在这里我们使用了 env.ROOT_GROUP_ID 通过环境变量来获取组 ID,这样可以避免硬编码。关于如何在 Pipelien 函数中使用环境变量,请见使用环境变量
  • 13 行调用回调函数 callback,第一个参数为 null,表示没有错误抛出,可以继续执行下面的认证流程。关于如何使用 callback 以及 Pipelien 函数的完整 API,请见 Pipeline 函数 API 文档

# 网络请求库

目前 Authing 支持使用 axios**,**且支持 async/await 语法 🚀!

axios 详细文档请移步其官方文档

# lodash

需要开发者手动导入:

const _ = require("lodash")

详细文档请移步其官方文档

# 内置工具集 utils

Authing 内置封装了一些实用的函数,供开发者直接调用。

需要开发者手动导入:

const utils = require("./utils")

# 检查 IP 是否位于 IP 段内

使用方法:

utils.ipRangeCheck(IP, [start, end])

返回值为 boolean。

示例:以下 Pipeline 函数实现注册 IP 段白名单功能。

async function pipe(context, callback) {
  const utils = require("./utils")
  const ip = context.ip
  if (ip && utils.ipRangeCheck(ip, ["110.53.254.1", "110.53.254.255"])) {
    return callback(null, context)
  }
  return callback(new Error('Access Denied!'))
}

# 其他 Node 自带 Module

Authing Pipeline 使用 node8 引擎,node8 的所有内置模块均可使用,如 querystring 等。