鸿蒙端手写 OBS 签名:五个让你只拿到 403 的地方
引子
鸿蒙端没有 OBS 的官方 SDK,想直接上传照片到自己的桶,只能自己按 Header 签名协议算 Authorization。云相册案例里的 ObsClient.ets 就是这么写的,一百来行 ArkTS,把签名、列举、上传、下载全手写了。
协议本身不长,但有几个地方一旦错,服务端只会回一个 403,什么也不告诉你。我把这个客户端读完,挑出五个最容易踩的点记一下。
签名到底签的是什么
OBS 的 Header 签名是五段拼接再加 HMAC-SHA1:
StringToSign = HTTP-Verb + "\n"
+ Content-MD5 + "\n"
+ Content-Type + "\n"
+ Date + "\n"
+ CanonicalizedHeaders
+ CanonicalizedResource
Signature = Base64(HMAC-SHA1(SK, StringToSign))
Authorization: OBS <AK>:<Signature>
代码里对应的方法很直白:
private async sign(verb: string, contentType: string, contentMd5: string,
date: string, canonicalizedResource: string,
canonicalizedHeaders: string = ''): Promise<string> {
const stringToSign = verb + '\n' + contentMd5 + '\n' + contentType + '\n' +
date + '\n' + canonicalizedHeaders + canonicalizedResource;
const signature = await this.hmacSha1(this.config.secretKey, stringToSign);
return `OBS ${this.config.accessKey}:${signature}`;
}
注意 CanonicalizedHeaders 和 CanonicalizedResource 之间没有换行符,前四段之间有。这是这个协议里唯一不对称的地方。
ArkTS 里怎么算 HMAC-SHA1
用的是系统 cryptoFramework,不需要三方库:
private async hmacSha1(key: string, data: string): Promise<string> {
const mac = await cryptoFramework.createMac('SHA1');
const symKey = await cryptoFramework.createSymKeyGenerator('HMAC')
.convertKey({ data: this.stringToUint8(key) });
await mac.init(symKey);
await mac.update({ data: this.stringToUint8(data) });
const raw = await mac.doFinal();
return this.base64Encode(raw.data);
}
createMac('SHA1') 配 createSymKeyGenerator('HMAC') 是固定搭配,别想着用 createSymKeyGenerator('SHA1')。Base64 用 util.Base64Helper 的 encodeToStringSync。
坑一:Content-MD5 是二进制的 base64,不是十六进制
上传时 Content-MD5 头要求的是 MD5 原始 16 字节的 base64,而不是常见的 32 位小写十六进制。如果手上只有 hex(比如从文件摘要算出来的是 hex),必须先转回去:
if (!/^[a-f0-9]{32}$/i.test(md5Hex)) { throw new Error('上传文件摘要无效'); }
const digest = new Uint8Array(16);
for (let i = 0; i < 16; i++) { digest[i] = parseInt(md5Hex.substring(i * 2, i * 2 + 2), 16); }
const contentMd5 = this.base64Encode(digest);
直接把 hex 字符串丢进 Content-MD5 会一直 403,而且服务端不会提示「格式不对」。
坑二:x-obs-* 头必须同时出现在两处
自定义头要以小写 x-obs- 开头、按字典序排列、每行以 \n 结尾,拼进 CanonicalizedHeaders。更关键的是:签名里用的那串必须和实际请求头逐字符一致。
案例里给自己加了一道保险,禁止同名对象被覆盖:
const authorization = await this.sign('PUT', contentType, contentMd5, date,
`/${this.config.bucket}/${this.encodeKey(objectKey)}`, 'x-obs-forbid-overwrite:true\n');
请求头里也要有 'x-obs-forbid-overwrite': 'true'。少一处、或者值写成 True,签名就对不上。
坑三:object key 的编码,签名和请求必须是同一个字符串
对象键里经常带 /(比如 photo_backup/2026/11/IMG_001.jpg)。encodeURIComponent 会把斜杠也转成 %2F,OBS 不认。所以编码后要把 %2F 换回来:
private encodeKey(key: string): string {
return encodeURIComponent(key).replace(/%2F/g, '/');
}
真正的陷阱在于:算 CanonicalizedResource 时用的是这个编码后的字符串,发请求的 URL path 也必须用同一个结果。两处只要有一处用了原始 key、另一处用了编码后的 key,403 就来了,而且你从错误码看不出是编码问题。
坑四:Date 必须用 GMT 格式
Date 头参与签名,格式必须是 HTTP 的 GMT 形式,不能用本地时间,也不能用 ISO 8601。案例里单独写了个 FormatUtil.formatGmt(),每次请求现算,不复用缓存的时间戳——签名有效期通常只有十几分钟,缓存 Date 是个很隐蔽的 bug。
坑五:列举对象的分页有三个边界
listObjects 用 max-keys=1000 加 marker 循环翻页,作者处理了三种异常:
const truncated = this.getTagValue(xml, 'IsTruncated').trim().toLowerCase();
if (truncated !== 'true' && truncated !== 'false') { throw new Error('云端分页响应无效'); }
hasMore = truncated === 'true';
if (hasMore) {
const next = this.decodeXml(this.getTagValue(xml, 'NextMarker')) ||
(list.length > 0 ? list[list.length - 1].key : '');
if (!next || next === marker) { throw new Error('云端分页游标无效'); }
marker = next;
}
三个边界分别是:IsTruncated 缺失时不能当成 false(会把结果截断而不自知);NextMarker 为空时要回退到最后一条 key(有些兼容实现不返回这个字段);游标没前进时要立刻报错(否则死循环,直到把桶刷完)。另外还设了 1000 页的硬上限。
一个顺手的设计取舍
首页要显示「已备份占了多少空间」。OBS 有桶级的统计接口,但它需要额外的桶读权限,而普通用户的 AK 通常只给了对象读写。作者的做法是:不加权限,改成列举 photo_backup/ 前缀下的对象,本地把 Size 累加。
代价是首屏要多发几次列举请求,收益是权限范围不变——只改动这一个功能就需要用户去控制台重新配 IAM,这种事用户不会做。
剩下的
客户端已经看完,下一步想真的跑一次:把本地相册里的几十张照片传上去,看分页在真实数据量下的表现,以及上传超时设成 600 秒是否够用。putObject 的 readTimeout 是 600000 毫秒,大视频上可能还是紧。
- 点赞
- 收藏
- 关注作者
评论(0)