使用访问密钥或共享访问签名对客户端Azure 事件网格进行身份验证

本文提供有关使用 访问密钥 或 共享访问签名 (SAS) 令牌对发布事件到 Azure 事件网格 主题、域、以及合作伙伴命名空间进行身份验证的信息。

使用访问密钥进行身份验证

访问密钥身份验证是最简单的身份验证形式。 可以将访问密钥作为 HTTP 标头或 URL 查询参数传递。

HTTP 标头中的访问密钥

将访问密钥作为 HTTP 标头的值传递：aeg-sas-key。

aeg-sas-key: XXXXXXXXXXXXXXXXXX0GXXX/nDT4hgdEj9DpBeRr38arnnm5OFg==

用作查询参数的访问密钥

还可以将 aeg-sas-key 指定为查询参数。

https://<yourtopic>.<region>.eventgrid.azure.cn/api/events?aeg-sas-key=XXXXXXXX53249XX8XXXXX0GXXX/nDT4hgdEj9DpBeRr38arnnm5OFg==

有关如何获取主题或域的访问密钥的说明，请参阅获取访问密钥。

使用 SAS 进行身份验证

事件网格资源的 SAS 令牌包括资源、过期时间和签名。 SAS 令牌的格式是：r={resource}&e={expiration}&s={signature}。

资源是您要将事件发送到的 Event Grid 主题的路径。 例如，有效的资源路径是 https://<yourtopic>.<region>.eventgrid.azure.cn/api/events。 若要查看所有受支持的 API 版本，请参阅 Microsoft。EventGrid 资源类型。

首先，以编程方式生成 SAS 令牌，然后使用 aeg-sas-token 标头或 Authorization SharedAccessSignature 标头向事件网格进行身份验证。

以编程方式生成 SAS 令牌

以下 C# 和Python示例演示如何创建用于事件网格的 SAS 令牌：

C# 示例

static string BuildSharedAccessSignature(string resource, DateTime expirationUtc, string key)
{
    const char Resource = 'r';
    const char Expiration = 'e';
    const char Signature = 's';

    string encodedResource = HttpUtility.UrlEncode(resource);
    var culture = CultureInfo.CreateSpecificCulture("en-US");
    var encodedExpirationUtc = HttpUtility.UrlEncode(expirationUtc.ToString(culture));

    string unsignedSas = $"{Resource}={encodedResource}&{Expiration}={encodedExpirationUtc}";
    using (var hmac = new HMACSHA256(Convert.FromBase64String(key)))
    {
        string signature = Convert.ToBase64String(hmac.ComputeHash(Encoding.UTF8.GetBytes(unsignedSas)));
        string encodedSignature = HttpUtility.UrlEncode(signature);
        string signedSas = $"{unsignedSas}&{Signature}={encodedSignature}";

        return signedSas;
    }
}

Python示例

def generate_sas_token(uri, key, expiry=3600):
    ttl = datetime.datetime.utcnow() + datetime.timedelta(seconds=expiry)
    encoded_resource = urllib.parse.quote_plus(uri)
    encoded_expiration_utc = urllib.parse.quote_plus(ttl.isoformat())

    unsigned_sas = f'r={encoded_resource}&e={encoded_expiration_utc}'
    signature = b64encode(HMAC(b64decode(key), unsigned_sas.encode('utf-8'), sha256).digest())
    encoded_signature = urllib.parse.quote_plus(signature)
    
    token = f'r={encoded_resource}&e={encoded_expiration_utc}&s={encoded_signature}'

    return token

使用 aeg-sas-token 标头

以下示例演示如何将 SAS 令牌作为 aeg-sas-token 标头的值传递。

aeg-sas-token: r=https%3a%2f%2fmytopic.eventgrid.azure.cn%2fapi%2fevents&e=6%2f15%2f2017+6%3a20%3a15+PM&s=XXXXXXXXXXXXX%2fBPjdDLOrc6THPy3tDcGHw1zP4OajQ%3d

使用授权标头

此示例演示如何将 SAS 令牌作为 Authorization 标头的值传递。

Authorization: SharedAccessSignature r=https%3a%2f%2fmytopic.eventgrid.azure.cn%2fapi%2fevents&e=6%2f15%2f2017+6%3a20%3a15+PM&s=XXXXXXXXXXXXX%2fBPjdDLOrc6THPy3tDcGHw1zP4OajQ%3d

后续步骤

• 将事件发送到自定义主题。