@crvouga/mockingbird-service-aws-iot (英语)

本地模拟器。 真正的API合同. 部分 嘲笑鸟。 。 。 .

国家模拟器 AWS IOT 核心数据平面 测试套房和地方开发: IoTData 计划 Publish hTTP 有签名版本 4 验证和 MQTT 5 信件 tCP和WebSocket的经纪人(/mqtt)与自定义授权政策,AWS IoT的持久性 课程规则及其与 MQTT 规格的偏离。 它在测试中运行 在没有 AWS 账户的 OS 指定端口上进行处理,会话到期会跟随套件的时钟 移动而不是等待.

• 行动覆盖( HTTP): 支助
• 没有AWS账户被用作甲骨文. 行为遵循 发布 API 引用, (中文(简体) ), 页:1 MQTT 数据, (中文(简体) ), 自定义认证, (中文(简体) ), 政策 财务报告和审定财务报表 配额 页面,以及AWS的SDK标志. 未结算的列在下面 未核实。 。 。 .
• 这不是EM Q的模仿者 与另一个名字: (单位:千美元)@crvouga/mockingbird-service-emqx)),各随自取.

安装

npm install -D @crvouga/mockingbird-service-aws-iot

仅限无害环境管理。 节点 22或 Bun 1.2. 无土生属地. 给它服务 npx mockingbird-aws-iot serve 或者说 createServer 从 ./server (节点和邦). createRuntime (默认条目)是可移植的:服务 Publish 结束 fetch 和 MQTT 通过 runtime.attach没有听者.

使用量

将应用程序的 IOT 数据端点指向 url 及其在 mqttUrl 或者说 wsUrl没有 TLS: 使用 http://, (中文(简体) ), mqtt:// 财务报告和审定财务报表 ws:// 给定的 URL .

import { createServer } from "@crvouga/mockingbird-service-aws-iot/server"
import { IoTDataPlaneClient, PublishCommand } from "@aws-sdk/client-iot-data-plane"
import mqtt from "mqtt"

// Test setup: start the emulator with the credentials and authorizer policies the test needs.
const arn = (resource: string) => `arn:aws:iot:us-east-1:123456789012:${resource}`
const iot = await createServer({
  settings: {
    // HTTP: SigV4 signatures are verified against these keys.
    credentials: [{ accessKeyId: "test-key", secretAccessKey: "test-secret" }],
    // MQTT: what the custom authorizer answers for a username and password.
    authorizers: [
      {
        username: "alice",
        password: "alice-token",
        policyDocuments: [
          {
            Version: "2012-10-17",
            Statement: [
              { Effect: "Allow", Action: "iot:Connect", Resource: arn("client/alice-*") },
              { Effect: "Allow", Action: "iot:Subscribe", Resource: arn("topicfilter/user/alice") },
              { Effect: "Allow", Action: "iot:Receive", Resource: arn("topic/user/alice") },
            ],
          },
        ],
      },
    ],
  },
})

// Application code: the MQTT client and AWS SDK client it already uses, pointed at the emulator.
const device = await mqtt.connectAsync(iot.mqttUrl, {
  protocolVersion: 5,
  clientId: "alice-phone",
  clean: false,
  properties: { sessionExpiryInterval: 600 },
  username: "alice",
  password: "alice-token",
})
await device.subscribeAsync("user/alice", { qos: 1 })

const client = new IoTDataPlaneClient({
  region: "us-east-1",
  endpoint: iot.url,
  credentials: { accessKeyId: "test-key", secretAccessKey: "test-secret" },
})
await client.send(new PublishCommand({ topic: "user/alice", qos: 1, payload: '{"hello":"alice"}' }))

await device.endAsync()
await iot.close() // closes every listener and drops every client

npx mockingbird-aws-iot serve --port 8851 --mqtt-port 8883 \
  --credential test-key:test-secret --settings ./aws-iot-settings.json

每个 createServer() 是它自己拥有自己的港口的经纪人,其中两个没有分享任何东西。 下 邦顿, mqtt节点 WebSocket 传输没有启动( Bun) ws 没有 createWebSocketStream,所以连接到 wsUrl 与库的浏览器传输 (单位:千美元)new MqttClient((c) => browserStreamBuilder(c, options), options) 从 mqtt/lib/connect/ws, (中文(简体) ), 或用途 connectStream(runtime) 从 ./server 用于无套接字连接。 在平原的节点上 mqtt.connect("ws://…/mqtt") 工作时.

话题是客户发送的。 AWS IOT 与 / 并给出 : 没有意义, 因此,一个名为主题的应用程序 user:example 并公布为 user/example 这样做 映射本身;模拟器像AWS一样,从未看到第一个形式.

路线

SigV4 (英语). 与 credentials 空的, 任何包含一个完整格式的请求 Authorization: AWS4-HMAC-SHA256 … 信头不被验证(作为Mockingbird的另一个AWS) 模拟者也这样做),未签名的请求仍然被拒绝. 已配置了证书 签名必须验证:服务 iotdata,配置的区域, host 财务报告和审定财务报表 x-amz-date 签名, 路径在犬科请求中编码了第二次(除了S3之外的所有服务),有效载荷 将身体的SHA -256,和 x-amz-security-token 匹配临时证书. 证书的 policyDocuments当给定时,必须允许 iot:Publish 打开 arn:aws:iot:<region>:<account>:topic/<topic>。 。 。 .

MQTT 数据

MQTT 5.0 在TCP和WebSocket上运行 /mqtt (副议定书) mqtt) (中文(简体) ). 都一样 各届会议和同一届会议 Publish 送货给.

管理员(超过标准合同)

错误预设( E)POST /__admin/faults {"preset": "<name>", "count"?: n}· ; GET /__admin/faults/presets: publish_throttled (单位:千美元)429 ThrottlingException, (中文(简体) ), publish_unauthorized (单位:千美元)401 UnauthorizedException, (中文(简体) ), publish_internal_failure (单位:千美元)500 InternalFailureException, (中文(简体) ), connect_not_authorized (结束) 0x87, (中文(简体) ), connect_bad_credentials (单位:千美元)0x86, (中文(简体) ), connect_quota_exceeded (单位:千美元)0x97) (中文(简体) ). CONNECT是故障操作 MqttConnect,所以任何原因 代码可以强制 : {"operationId": "MqttConnect", "effect": "connack", "params": {"reasonCode": 137}}。 。 。 .

命名空间

平行工人通过命名空间孤立自己. HTTP : (韩语) x-mockingbird-namespace页:1 /__admin/ns/<name> 前缀在终点,或通过访问密钥 id (单位:千美元)PUT /__admin/credentials {"credentials": {"<AWS_ACCESS_KEY_ID>": "<namespace>"}}(原始内容存档于2017-09-26). MQTT: the WebSocket URL 网络软件 ws://…/__admin/ns/<name>/mqtt,或由 CONNECT 键入的同一证书地图 用户名(没有查询字符串),然后是其客户端 ID。 未实现客户端使用默认值 名称空间.

未核实

文档不会解决这些问题; 模拟者的选择被声明为套房不会 给卖家弄错了

• 圆满之体. API的参考文献说 Publish 回答空正文; AWS 的自定义 认证教程显示 {"message": "OK", "traceId": "…"}。模拟器发送 后者,SDK忽略了这一点.
• 拒证. 未签名的请求或未验证仿真器的签名 答题 403 {"message": "Forbidden", "traceId"} 与 x-amzn-ErrorType: ForbiddenException数字 : 主体是拒绝的自定义授权签名的 AWS 文件、状态和 标题是推断的。 用于有效签名而无需 iot:Publish 它回答了文件 401 UnauthorizedException;无论AWS回答401还是403,都没有确认.
• AWS 是否发送 x-amzn-ErrorType,则 message 每个文本 400,则 HTTP 错误 128 KB以上的有效载荷(模拟器用途) 400 InvalidRequestException) (中文(简体) ).
• "128 KB"和"146 KB"被取为131072和149504字节. AWS的MQTT页面也提到 最大包大小"不能超过128 KB";使用配额页146 KB.
• 客户所看到的 isAuthenticated: false (AWS说它"结束了连接"; 模拟器发送 CONNACK 0x87 首先,对于一个超越限制范围或始于 $ (AWS说此类操作"可以导致终止连接";模拟器回答 苏巴克 0x8F / 弹夹 0x90 并保持连接),以及超大小的MQTT有效载荷 (DISCONENECT 存档副本) 0x95) (中文(简体) ).
• 一个QoS 2 子公司获得没有SUBACK是AWS的有记录的行为,在没有协议的情况下声明 版本;它被应用于已写入的 MQTT 5 .
• 当服务器保持生存时,接收最大值(100, 从未承认出版物配额中提取) 发送,指定客户端 ID 的格式,以及 Lambda 事件是否 username 包括查询字符串(模拟器将其剥去).
• 签名日期不与时钟相对照,所以套房可以冻结时间.

故意不模拟

• MQTT 3.1和3.1.1(与该协议的回回码重用), TLS, X. 509 客户端 证书、 ALPN 和 SNI 以及 SigV4 指定的 WebSocket URL .
• 自定义对 HTTP 、 符号签名和 disconnectAfterInSeconds 编号 : refreshAfterInSeconds (接受,未执行).
• 政策 Condition, (中文(简体) ), NotAction 财务报告和审定财务报表 NotResource (拒绝使用这些文件)政策 变量 ${iot:ClientId},以及 iot:RetainPublish。 。 。 .
• 保留消息: CONNACK 表示保留可使用 0, 保留 MQTT 的发布被解答 分解系统 0x9A,以及 retain=true 超过HTTP是 400AWS本身支持它们.
• 将信件(收受于CONNECT,从未发布),共享订阅(SUBACK) 0x9E, (中文(简体) ), 保留动态超时、消息过期、外出主题别名和保留 $aws/… 专题.
• 比率和计数配额(每秒publishes、每条连接或每条附属CRIBE、, 存储会话的每秒重放10个消息.
• 记录 阴影 规则和行动 工作 供给 其它数据平面 业务、账单和基础设施管理.

API 密码

部分 嘲笑鸟。 。 。 .