淘宝开放平台

说明

目前支持Callback的API接口包括PutObject、PostObject和CompleteMultipartUpload。关于Callback的更多信息，请参见原理介绍。
Callback目前不支持服务器名称指示SNI（Server Name Indication）。

步骤1：构造参数

Callback参数

Callback参数是由一段经过Base64编码的JSON字符串（字段）。构建callback参数的关键是指定请求回调的服务器URL（callbackUrl）以及回调的内容（callbackBody）。

JSON字段的详细信息请参见下表。


字段	描述	是否必选
callbackUrl	文件上传成功后，OSS向此URL发送回调请求，请求方法为POST，body为callbackBody指定的内容。正常情况下，该URL需要响应`HTTP/1.1 200 OK`，body必须为JSON格式，响应头Content-Length必须为合法的值，且大小不超过3 MB。支持同时配置最多5个URL，多个URL间以分号（;）分隔。OSS会依次发送请求直到第一个返回成功为止。如果未配置或者配置值为空则表示未配置callback。支持HTTPS地址。为了保证正确处理中文等情况，callbackUrl需做URL编码处理，例如`http://example.com/中文.php?key=value&中文名称=中文值`需要编码成`http://example.com/%E4%B8%AD%E6%96%87.php?key=value&%E4%B8%AD%E6%96%87%E5%90%8D%E7%A7%B0=%E4%B8%AD%E6%96%87%E5%80%BC`。	是
callbackHost	发起回调请求时Host头的值，只有在设置了callbackUrl时才有效。如果没有配置callbackHost，则会解析callbackUrl中的URL并将解析出的host填充到callbackHost中。	否
callbackBody	发起回调时请求body的值，例如key=${object}&etag=${etag}&my_var=${x:my_var}。支持OSS系统变量、自定义变量和常量，支持的系统变量如下表所示。自定义变量的支持方式在PutObject和CompleteMultipart中是通过callback-var来传递，在PostObject中则是将各个变量通过表单域来传递。	是
callbackBodyType	发起回调请求的Content-Type，支持application/x-www-form-urlencoded和application/json，默认为前者。 callbackBodyType的取值为application/x-www-form-urlencoded，则callbackBody中的变量将会被经过URL编码的值替换掉；如果为application/json，则会按照JSON格式替换其中的变量。	否

JSON字段示例如下：

{
"callbackUrl":"172.16.XX.XX/test.php",
"callbackHost":"oss-cn-hangzhou.aliyuncs.com",
"callbackBody":"{\"mimeType\":${mimeType},\"size\":${size}}",
"callbackBodyType":"application/json"
}

{
"callbackUrl":"172.16.XX.XX:23456/index.html",
"callbackBody":"bucket=${bucket}&object=${object}&etag=${etag}&size=${size}&mimeType=${mimeType}&imageInfo.height=${imageInfo.height}&imageInfo.width=${imageInfo.width}&imageInfo.format=${imageInfo.format}&my_var=${x:my_var}"
}

callbackBody中可以设置的系统参数请参见下表。


系统参数	含义
bucket	存储空间
object	对象（文件）
etag	文件的ETag，即返回给用户的ETag字段
size	Object大小，CompleteMultipartUpload时为整个Object的大小
mimeType	资源类型，例如jpeg图片的资源类型为image/jpeg
imageInfo.height	图片高度
imageInfo.width	图片宽度
imageInfo.format	图片格式，例如jpg、png等

说明 imageInfo针对图片格式，如果为非图片格式，imageInfo.height、imageInfo.width、imageInfo.format都为空。

callback-var自定义参数
用户可以通过callback-var参数来配置自定义参数。自定义参数是一个Key-Value的Map，用户可以配置自己需要的参数到该Map。在OSS发起POST回调请求的时候，会将这些参数和上述的系统参数一起放在POST请求的body中以方便接收回调方获取。

构造自定义参数的方法和callBack参数的方法是一样的，也是以JSON格式来传递。该JSON字符串就是一个包含所有自定义参数的Key-Value的Map。

说明用户自定义参数的Key一定要以x:开头且必须为小写，否则OSS会返回错误。

假定用户需要设定两个自定义的参数分别为x:var1和x:var2，对应的值分别为value1和value2，那么构造出来的JSON格式如下：
```
{
"x:var1":"value1",
"x:var2":"value2"
}
```

说明如果传入的callback或者callback-var参数不合法，则会返回400错误，错误码为”InvalidArgument”，不合法的情况包括以下几类：

PutObject()和CompleteMultipartUpload()接口中URL和header同时传入callback(x-oss-callback)或者callback-var(x-oss-callback-var)参数。
callback或者callback-var参数过长，超过5 KB。由于PostObject()没有callback-var参数，因此无此限制，下同。
callback或者callback-var参数没有经过base64编码或经过base64解码后不是合法的JSON格式。
callback参数解析后callbackUrl字段包含的URL超过限制（5个），或者URL中传入的port不合法，例如
```
{"callbackUrl":"172.16.XX.XX:test",
    "callbackBody":"test"}
```
callback参数解析后callbackBody字段为空。
callback参数解析后callbackBodyType字段的值不是application/x-www-form-urlencoded或者application/json。
callback参数解析后callbackBody字段中变量的格式不合法，合法的格式为${var}。
callback-var参数解析后不是预期的JSON格式，预期的格式为{"x:var1":"value1","x:var2":"value2"}。

步骤2：构造回调请求

构造完成上述的callback和callback-var两个参数后，需将参数附加到OSS的请求中。

附加方式共有三种，方式如下：

在URL中携带参数。
在Header中携带参数。
在POST请求的body中使用表单域来携带参数。

说明在使用POST请求上传object时只能使用这种方式来指定回调参数。

以上三种方式只能同时使用其中一种，否则OSS会返回InvalidArgument错误。

要将参数附加到OSS的请求中，首先要将上文构造的JSON字符串使用base64编码，然后按照如下的方法附加到OSS的请求中。

如果在URL中携带参数。把callback=[CallBack]或者callback-var=[CallBackVar]作为一个URL参数带入请求发送。计算签名CanonicalizedResource时，将callback或者callback-var当做一个sub-resource计算在内。

如果在Header中携带参数。把x-oss-callback=[CallBack]或者x-oss-callback-var=[CallBackVar]作为一个Header带入请求发送。在计算签名CanonicalizedOSSHeaders时，将x-oss-callback-var和x-oss-callback计算在内。示例如下：

PUT /test.txt HTTP/1.1
Host: callback-test.oss-test.aliyun-inc.com
Accept-Encoding: identity
Content-Length: 5
x-oss-callback-var: eyJ4Om15X3ZhciI6ImZvci1jYWxsYmFjay10ZXN0In0=
User-Agent: aliyun-sdk-python/0.4.0 (Linux/2.6.32-220.23.2.ali1089.el5.x86_64/x86_64;2.5.4)
x-oss-callback: eyJjYWxsYmFja1VybCI6IjEyMS40My4xMTMuODoyMzQ1Ni9pbmRleC5odG1sIiwgICJjYWxsYmFja0JvZHkiOiJidWNrZXQ9JHtidWNrZXR9Jm9iamVjdD0ke29iamVjdH0mZXRhZz0ke2V0YWd9JnNpemU9JHtzaXplfSZtaW1lVHlwZT0ke21pbWVUeXBlfSZpbWFnZUluZm8uaGVpZ2h0PSR7aW1hZ2VJbmZvLmhlaWdodH0maW1hZ2VJbmZvLndpZHRoPSR7aW1hZ2VJbmZvLndpZHRofSZpbWFnZUluZm8uZm9ybWF0PSR7aW1hZ2VJbmZvLmZvcm1hdH0mbXlfdmFyPSR7eDpteV92YXJ9In0=
Host: callback-test.oss-test.aliyun-inc.com
Expect: 100-Continue
Date: Mon, 14 Sep 2015 12:37:27 GMT
Content-Type: text/plain
Authorization: OSS mlepou3zr4u7b14:5a74vhd4UXpmyuudV14Kaen5****
Test

在POST请求的body中使用表单域来携带参数。

如果需要在POST上传Object时附带回调参数，callback参数要使用独立的表单域来附加，示例如下：

--9431149156168
Content-Disposition: form-data; name="callback"
eyJjYWxsYmFja1VybCI6IjEwLjEwMS4xNjYuMzA6ODA4My9jYWxsYmFjay5waHAiLCJjYWxsYmFja0hvc3QiOiIxMC4xMDEuMTY2LjMwIiwiY2FsbGJhY2tCb2R5IjoiZmlsZW5hbWU9JChmaWxlbmFtZSkmdGFibGU9JHt4OnRhYmxlfSIsImNhbGxiYWNrQm9keVR5cGUiOiJhcHBsaWNhdGlvbi94LXd3dy1mb3JtLXVybGVuY29kZWQifQ==

如果是自定义参数，不能直接将callback-var参数直接附加到表单域中，每个自定义的参数都需要使用独立的表单域来附加。如果用户的自定义参数JSON字段示例如下：

{
"x:var1":"value1",
"x:var2":"value2"
}

那么POST请求的表单域为：

--9431149156168
Content-Disposition: form-data; name="callback"
eyJjYWxsYmFja1VybCI6IjEwLjEwMS4xNjYuMzA6ODA4My9jYWxsYmFjay5waHAiLCJjYWxsYmFja0hvc3QiOiIxMC4xMDEuMTY2LjMwIiwiY2FsbGJhY2tCb2R5IjoiZmlsZW5hbWU9JChmaWxlbmFtZSkmdGFibGU9JHt4OnRhYmxlfSIsImNhbGxiYWNrQm9keVR5cGUiOiJhcHBsaWNhdGlvbi94LXd3dy1mb3JtLXVybGVuY29kZWQifQ==
--9431149156168
Content-Disposition: form-data; name="x:var1"
value1
--9431149156168
Content-Disposition: form-data; name="x:var2"
value2

同时可以在policy中添加callback条件，如果不添加callback条件，则不对该参数做上传验证，如下所示。

{ "expiration": "2021-12-01T12:00:00.000Z",
  "conditions": [
    {"bucket": "johnsmith" },
    {"callback": "eyJjYWxsYmFja1VybCI6IjEwLjEwMS4xNjYuMzA6ODA4My9jYWxsYmFjay5waHAiLCJjYWxsYmFja0hvc3QiOiIxMC4xMDEuMTY2LjMwIiwiY2FsbGJhY2tCb2R5IjoiZmlsZW5hbWU9JChmaWxlbmFtZSkiLCJjYWxsYmFja0JvZHlUeXBlIjoiYXBwbGljYXRpb24veC13d3ctZm9ybS11cmxlbmNvZGVkIn0="},
    ["starts-with", "$key", "user/eric/"],
  ]
}

步骤3：发起回调请求

如果文件上传成功，OSS会根据用户请求中的callback参数和callback-var自定义参数，将特定内容以POST方式发送给应用服务器。

POST /index.html HTTP/1.0
Host: 172.16.XX.XX
Connection: close
Content-Length: 181
Content-Type: application/x-www-form-urlencoded
User-Agent: http-client/0.0.1
bucket=callback-test&object=test.txt&etag=D8E8FCA2DC0F896FD7CB4CB0031BA249&size=5&mimeType=text%2Fplain&imageInfo.height=&imageInfo.width=&imageInfo.format=&x:var1=for-callback-test

（可选）步骤4：回调签名

用户设置callback参数后，OSS将按照用户设置的callbackUrl发送POST回调请求给用户的应用服务器。应用服务器收到回调请求之后，如果希望验证回调请求确实是由OSS发起的话，可以通过在回调中带上签名来验证OSS的身份。

生成签名
签名发生在OSS端，采用RSA非对称方式。

私钥加密生成签名的过程为：
```
authorization = base64_encode(rsa_sign(private_key, url_decode(path) + query_string + ‘\n’ + body, md5))
```
说明其中private_key为私钥，只有OSS知晓，path为回调请求的资源路径，query_string为查询字符串，body为回调的消息体。

签名过程分为以下三步：
1. 获取待签名字符串：资源路径经过URL解码后，加上原始的查询字符串、加上一个回车符、然后加上回调消息体。
2. RSA签名：使用密钥对待签名字符串进行签名，签名的hash函数为md5。
3. 将签名后的结果做base64编码，得到最终的签名，签名放在回调请求的authorization头中。
示例如下：
```
POST /index.php?id=1&index=2 HTTP/1.0
Host: 172.16.XX.XX
Connection: close
Content-Length: 18
authorization: kKQeGTRccDKyHB3H9vF+xYMSrmhMZjzzl2/kdD1ktNVgbWEfYTQG0G2SU/RaHBovRCE8OkQDjC3uG33esH2t****
Content-Type: application/x-www-form-urlencoded
User-Agent: http-client/0.0.1
x-oss-pub-key-url: aHR0cDovL2dvc3NwdWJsaWMuYWxpY2RuLmNvbS9jYWxsYmFja19wdWJfa2V5X3YxLn****==
bucket=yonghu-test
```
path为/index.php，query_string为?id=1&index=2，body为bucket=yonghu-test，最终签名结果为kKQeGTRccDKyHB3H9vF+xYMSrmhMZjzzl2/kdD1ktNVgbWEfYTQG0G2SU/RaHBovRCE8OkQDjC3uG33esH2txA==。
验证签名
验证签名的过程即为签名的逆过程，由应用服务器验证，过程如下：
```
Result = rsa_verify(public_key, md5(url_decode(path) + query_string + ‘\n’ + body), base64_decode(authorization))
```
字段的含义与签名过程中描述相同，其中public_key为公钥，authorization为回调头中的签名，整个验证签名的过程分为以下几步：
1. 回调请求的x-oss-pub-key-url头保存的是公钥URL地址的base64编码，因此需要对其做base64解码后获取到公钥，即
```
public_key = urlopen(base64_decode(x-oss-pub-key-url头的值))
```
  说明为了保证该public_key是由OSS颁发的，用户需要校验 x-oss-pub-key-url头的值必须以 http://gosspublic.alicdn.com/或者 https://gosspublic.alicdn.com/开头。
2. 获取base64解码后的签名
```
signature = base64_decode(authorization头的值)
```
3. 获取待签名字符串，方法与签名一致
```
sign_str = url_decode(path) + query_string + ‘\n’ + body
```
4. 验证签名
```
result = rsa_verify(public_key, md5(sign_str), signature)
```
以上述示例来说明验证签名的完整过程：
1. 获取到公钥的URL地址，即aHR0cDovL2dvc3NwdWJsaWMuYWxpY2RuLmNvbS9jYWxsYmFja19wdWJfa2V5X3YxLnBlbQ==经过base64解码后得到http://gosspublic.alicdn.com/callback_pub_key_v1.pem。
2. 签名头kKQeGTRccDKyHB3H9vF+xYMSrmhMZjzzl2/kdD1ktNVgbWEfYTQG0G2SU/RaHBovRCE8OkQDjC3uG33esH2txA==做base64解码（由于为非打印字符，无法显示出解码后的结果）。
3. 获取待签名字符串，即url_decode(“index.php”) + “?id=1&index=2” + “\n” + “bucket=yonghu-test”，并做MD5校验。
4. 验证签名。

应用服务器示例

如下以Python为例，演示了一个简单的应用服务器，主要说明验证签名的方法，此示例需要安装M2Crypto库。

import httplib
import base64
import md5
import urllib2
from BaseHTTPServer import BaseHTTPRequestHandler, HTTPServer
from M2Crypto import RSA
from M2Crypto import BIO
def get_local_ip():
    try:
        csock = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
        csock.connect(('8.8.8.8', 80))
        (addr, port) = csock.getsockname()
        csock.close()
        return addr
    except socket.error:
        return ""
class MyHTTPRequestHandler(BaseHTTPRequestHandler):
    '''
    def log_message(self, format, *args):
        return
    '''
    def do_POST(self):
        #get public key
        pub_key_url = ''
        try:
            pub_key_url_base64 = self.headers['x-oss-pub-key-url']
            pub_key_url = pub_key_url_base64.decode('base64')
            if not pub_key_url.startswith("http://gosspublic.alicdn.com/") and not pub_key_url.startswith("https://gosspublic.alicdn.com/"):
                self.send_response(400)
                self.end_headers()
                return
            url_reader = urllib2.urlopen(pub_key_url)
            #you can cache it
            pub_key = url_reader.read() 
        except:
            print 'pub_key_url : ' + pub_key_url
            print 'Get pub key failed!'
            self.send_response(400)
            self.end_headers()
            return
        #get authorization
        authorization_base64 = self.headers['authorization']
        authorization = authorization_base64.decode('base64')
        #get callback body
        content_length = self.headers['content-length']
        callback_body = self.rfile.read(int(content_length))
        #compose authorization string
        auth_str = ''
        pos = self.path.find('?')
        if -1 == pos:
            auth_str = urllib2.unquote(self.path) + '\n' + callback_body
        else:
            auth_str = urllib2.unquote(self.path[0:pos]) + self.path[pos:] + '\n' + callback_body
        print auth_str
        #verify authorization
        auth_md5 = md5.new(auth_str).digest()
        bio = BIO.MemoryBuffer(pub_key)
        rsa_pub = RSA.load_pub_key_bio(bio)
        try:
            result = rsa_pub.verify(auth_md5, authorization, 'md5')
        except:
            result = False
        if not result:
            print 'Authorization verify failed!'
            print 'Public key : %s' % (pub_key)
            print 'Auth string : %s' % (auth_str)
            self.send_response(400)
            self.end_headers()
            return
        #do something according to callback_body
        #response to OSS
        resp_body = '{"Status":"OK"}'
        self.send_response(200)
        self.send_header('Content-Type', 'application/json')
        self.send_header('Content-Length', str(len(resp_body)))
        self.end_headers()
        self.wfile.write(resp_body)
class MyHTTPServer(HTTPServer):
    def __init__(self, host, port):
        HTTPServer.__init__(self, (host, port), MyHTTPRequestHandler)
if '__main__' == __name__:
    server_ip = get_local_ip()
server_port = 23451
server = MyHTTPServer(server_ip, server_port)
server.serve_forever()

其它语言的服务端代码请参见下表。


SDK语言	描述
Java	下载地址：Java 运行方法：解压包运行`java -jar oss-callback-server-demo.jar 9000`（9000指运行的端口，可以自行指定）。
Python	下载地址：Python 运行方法：解压包直接运行`python callback_app_server.py`，运行该程序需要安装RSA的依赖。
Go	下载地址：Go 运行方法：解压后参看README.md。
PHP	下载地址：PHP 运行方法：部署到Apache环境下，因为PHP本身语言的特点，取一些数据头部会依赖于环境。所以可以参考例子根据所在环境修改。
.NET	下载地址：.NET 运行方法：解压后参看`README.md`。
Node.js	下载地址：Node.js 运行方法：解压包直接运行`node example.js`。
Ruby	下载地址：Ruby 运行方法：ruby aliyun_oss_callback_server.rb

步骤5：返回回调结果

应用服务器返回响应给OSS。

返回的回调请求为：

HTTP/1.0 200 OK
Server: BaseHTTP/0.3 Python/2.7.6
Date: Mon, 14 Sep 2015 12:37:27 GMT
Content-Type: application/json
Content-Length: 9
{"a":"b"}

说明应用服务器返回OSS的响应必须带有Content-Length的Header，Body大小不能超过1 MB。

步骤6：返回上传结果

OSS将应用服务器返回的内容返回给用户。

返回的内容响应为：

HTTP/1.1 200 OK
Date: Mon, 14 Sep 2015 12:37:27 GMT
Content-Type: application/json
Content-Length: 9
Connection: keep-alive
ETag: "D8E8FCA2DC0F896FD7CB4CB0031BA249"
Server: AliyunOSS
x-oss-bucket-version: 1442231779
x-oss-request-id: 55F6BF87207FB30F2640C548
{"a":"b"}

说明

如果类似CompleteMultipartUpload这样的请求，在返回请求本身body中存在内容（例如XML格式的信息），使用上传回调功能后会覆盖原有的body中的内容例如{"a":"b"}，希望对此处做好判断处理。
如果回调失败，则返回203，错误码为”CallbackFailed”。文件已经成功上传到了OSS，但回调失败。回调失败只是表示OSS没有收到预期的回调响应，不代表应用服务器没有收到回调请求（例如应用服务器返回的内容不是JSON格式）。

对象存储 OSS

Callback