Özet kimlik doğrulama (AppKey ve AppSecret) kullanan API'ler, istemcilerin her isteği imzalamasını gerektirir. API Gateway SDK'ları imzalama işlemini otomatik olarak halleder. Bu konu, özel istemci uygulamaları için imzalama sürecini açıklar.
Genel Bakış
API Gateway, istek imzalarını şu amaçlarla oluşturur ve doğrular:
İsteklerin yetkili AppKey'e dayalı doğru bir imza içerdiğini doğrulamak.
İletim sırasında isteklerin değiştirilmesini önlemek.
API sağlayıcıları, API Gateway konsolunun Uygulamalar sayfasında uygulamalar oluşturur. Her uygulamanın bir imza anahtar çifti (AppKey ve AppSecret) bulunur. Sağlayıcı bir uygulamanın API'yi çağırmasına yetki verdikten sonra, arayanlar istekleri imzalamak için bu anahtar çiftini kullanır. Uygulama, sağlayıcıya veya arayana ait olabilir.
Bir istemci API'yi çağırdığında, yetkili anahtar çiftiyle isteği imzalar ve AppKey ile imzayı istek üstbilgisine ekler. API Gateway, AppKey'i okur, karşılık gelen AppSecret'ı alır ve imzayı yeniden hesaplar. Hesaplanan imza istemci imzasıyla eşleşirse istek arka uç hizmetine iletilir. Aksi takdirde API Gateway bir hata döndürür.
API Gateway yalnızca Güvenlik Kimlik Doğrulaması Alibaba Cloud App olarak ayarlanmış API'ler için imzaları doğrular.
SDK'larla API çağırma
API Gateway; Java, Android ve Objective-C için yerleşik imzalama mantığı ve kaynak kodu içeren SDK'lar sağlar. Bunları API Gateway konsolundan indirin:
API > SDK'lar seçeneğini açın
API Çağır > Yetkili API SDK seçeneğine gidin
Daha fazla bilgi için bkz. SDK'ları kullanarak API çağırma.
Özet kimlik doğrulama ilkeleri
3,1. İmza oluşturma ve doğrulama
3,1.1. Ön koşullar
API arayanı, hedef API için imza anahtar çiftini almıştır.
APP Anahtarı
APP Gizli Anahtarı
Hedef API'nin Güvenlik Kimlik Doğrulaması Alibaba Cloud App olarak ayarlanmıştır.
3,1.2. İstemcilerde imza oluşturma
İmza oluşturmak için:
İmza dizesi elde etmek üzere istekten anahtar verileri çıkarın.
İmza dizesini AppSecret ile şifreleyerek imza üretin.
İmza ile ilgili tüm üstbilgileri HTTP isteğine ekleyin.
3,1.3. Sunucularda imza doğrulama
İstemci imzasını doğrulamak için:
İmza dizesi oluşturmak üzere istekten anahtar verileri çıkarın.
AppKey'i istekten okuyun ve karşılık gelen AppSecret'ı alın.
İmza dizesini AppSecret ile şifreleyerek imza üretin.
Sunucu tarafındaki imzayı istekteki istemci tarafı imzasıyla karşılaştırın.
3,2. İmza oluşturma ve aktarma
3,2.1. İmza dizesinin çıkarılması
HTTP isteğinden anahtar verileri çıkarın ve aşağıdaki biçimde bir imza dizesinde birleştirin:
HTTPMethod
Accept
Content-MD5
Content-Type
Date
Headers
PathAndParameters
Bu alanlar \n ile ayrılır. Headers boşsa \n öğesini atlayın. Diğer boş alanlar için \n değerini koruyun. İmza büyük/küçük harfe duyarlıdır. Her alan aşağıdaki gibi çıkarılır:
HTTPMethod: İsteği göndermek için kullanılan HTTP yöntemi (örneğin, POST). Büyük harfle yazılmalıdır.
Accept: Accept üstbilgisinin değeri. Boş bırakılabilir ancak açıkça ayarlamanızı öneririz. Bazı HTTP istemcileri varsayılan olarak / değerini kullanır; bu durum imza doğrulamanın başarısız olmasına neden olur.
-
Content-MD5: Content-MD5 üstbilgisinin değeri. İsteğe bağlıdır.
Yalnızca Form gövdesi olmayan istekler için hesaplanır. İstemci Content-MD5'i atlarsa API Gateway doğrulamayı atlar.
Content-MD5 hesaplaması için Java örneği:
String content-MD5 = Base64.encodeBase64(MD5(bodyStream.getbytes("UTF-8")));
Content-Type: Content-Type üstbilgisinin değeri. İsteğe bağlıdır.
Bir Content-Type uyumsuzluğu oluşursa (örneğin, WeChat mini programı aracılığıyla dosya aktarırken), X-Ca-Signed-Content-Type:multipart/form-data değerini özel üstbilgi olarak ekleyin. API Gateway, mevcut olduğunda imzalama için bu üstbilgiyi kullanır.
Date: Date üstbilgisinin değeri. İsteğe bağlıdır.
-
Headers: İmzaya dahil edilecek özel üstbilgiler. Birleştirme kuralları:
Üstbilgi anahtarlarını alfabetik olarak sıralayın ve aşağıdaki gibi birleştirin:
HeaderKey1 + ":" + HeaderValue1 + "\n" + HeaderKey2 + ":" + HeaderValue2 + "\n" + ... HeaderKeyN + ":" + HeaderValueN + "\n"Bir üstbilgi değeri boşsa HeaderKey + ":" + "\n" kullanın ve anahtarı iki nokta üst üste işaretini (:) koruyun.
İmzalama için kullanılan üstbilgi anahtarlarını virgülle (,) ayırarak X-Ca-Signature-Headers üstbilgisine yerleştirin.
Aşağıdaki üstbilgiler imza hesaplaması için kullanılamaz: X-Ca-Signature, X-Ca-Signature-Headers, Accept, Content-MD5, Content-Type ve Date.
-
PathAndParameters: Tüm Path, Query ve Form parametrelerini içerir.
Path + "?" + Key1 + "=" + Value1 + "&" + Key2 + "=" + Value2 + ... "&" + KeyN + "=" + ValueNQuery ve Form parametre anahtarlarını alfabetik olarak sıralayın, ardından yukarıda gösterildiği gibi birleştirin.
Query ve Form parametreleri boşsa soru işareti (?) eklemeden yalnızca Path'i kullanın.
Bir parametre değeri boşsa imzalama için yalnızca anahtarı kullanın.
Aynı anahtara sahip ancak farklı değerlere sahip dizi parametreleri için imzalama amacıyla yalnızca ilk değer kullanılır.
Örnek HTTP isteği:
POST /http2test/test?param1=test HTTP/1.1
host:api.alibabacloud.com
accept:application/json; charset=utf-8
ca_version:1
content-type:application/x-www-form-urlencoded; charset=utf-8
x-ca-timestamp:1525872629832
date:Wed, 09 May 2018 13:30:29 GMT+00:00
user-agent:ALIYUN-ANDROID-DEMO
x-ca-nonce:c9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44
content-length:33
username=xiaoming&password=123456789
Bu istek için oluşturulan imza dizesi:
POST
application/json; charset=utf-8
application/x-www-form-urlencoded; charset=utf-8
Wed, 09 May 2018 13:30:29 GMT+00:00
x-ca-key:203753385
x-ca-nonce:c9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44
x-ca-signature-method:HmacSHA256
x-ca-timestamp:1525872629832
/http2test/test?param1=test&password=123456789&username=xiaoming
3,2.2. İmza hesaplama
Anahtar verileri bir imza dizesinde birleştirdikten sonra son imzayı üretmek için şifreleyin ve kodlayın. Desteklenen algoritmalar:
HmacSHA256
HmacSHA1
Şifreleme örnekleri; burada stringToSign imza dizesi, appSecret ise AppSecret'tır:
Mac hmacSha256 = Mac.getInstance("HmacSHA256");
byte[] appSecretBytes = appSecret.getBytes(Charset.forName("UTF-8"));
hmacSha256.init(new SecretKeySpec(appSecretBytes, 0, appSecretBytes.length, "HmacSHA256"));
byte[] md5Result = hmacSha256.doFinal(stringToSign.getBytes(Charset.forName("UTF-8")));
String signature = Base64.encodeBase64String(md5Result);
Mac hmacSha1 = Mac.getInstance("HmacSHA1");
byte[] appSecretBytes = appSecret.getBytes(Charset.forName("UTF-8"));
hmacSha1.init(new SecretKeySpec(appSecretBytes, 0, appSecretBytes.length, "HmacSHA1"));
byte[] md5Result = hmacSha1.doFinal(stringToSign.getBytes(Charset.forName("UTF-8")));
String signature = Base64.encodeBase64String(md5Result);
StringToSign, UTF-8 bayt dizisi olarak kodu çözülür, şifrelenir ve ardından son imzayı üretmek için Base64 ile kodlanır.
3,2.3. İmza aktarma
API Gateway'e gönderilen isteklere aşağıdaki üstbilgileri ekleyin:
x-ca-key: AppKey. Bu parametre zorunludur.
x-ca-signature-method: İmza yöntemi. Bu parametre isteğe bağlıdır. Geçerli değerler: HmacSHA256 ve HmacSHA1. Varsayılan değer: HmacSHA256.
X-Ca-Signature-Headers: Tüm imza üstbilgilerinin anahtarları. Bu parametre isteğe bağlıdır. Birden çok anahtarı virgülle (,) ayırın.
X-Ca-Signature: İmza. Bu parametre zorunludur.
Örnek imzalı HTTP isteği:
POST /http2test/test?param1=test HTTP/1.1
host:api.alibabacloud.com
accept:application/json; charset=utf-8
ca_version:1
content-type:application/x-www-form-urlencoded; charset=utf-8
x-ca-timestamp:1525872629832
date:Wed, 09 May 2018 13:30:29 GMT+00:00
user-agent:ALIYUN-ANDROID-DEMO
x-ca-nonce:c9f15cbf-f4ac-4a6c-b54d-f51abf4b5b44
x-ca-key:203753385
x-ca-signature-method:HmacSHA256
x-ca-signature-headers:x-ca-timestamp,x-ca-key,x-ca-nonce,x-ca-signature-method
x-ca-signature:xfX+bZxY2yl7EB/qdoDy9v/uscw3Nnj1pgoU+Bm6xdM=
content-length:33
username=xiaoming&password=123456789
3,3. Sorun giderme
İmza doğrulaması başarısız olursa API Gateway, sunucu tarafındaki StringToSign değerini X-Ca-Error-Message yanıt üstbilgisinde döndürür. Farklılıkları belirlemek için bunu istemci tarafındaki StringToSign ile karşılaştırın.
Her iki dize de eşleşiyorsa imzalama için kullanılan AppSecret'ı doğrulayın.
HTTP üstbilgileri satır sonlarını desteklemez. StringToSign içindeki satır sonları diyez işaretleriyle (#) değiştirilir.
errorMessage: Invalid Signature, Server StringToSign:`GET#application/json##application/json##X-Ca-Key:200000#X-Ca-Timestamp:1589458000000#/app/v1/config/keys?keys=TEST`
Örnek sunucu tarafı imza dizesi:
GET
application/json
application/json
X-Ca-Key:200000
X-Ca-Timestamp:1589458000000
/app/v1/config/keys?keys=TEST