注意事項

無論是STS鑒權模式還是自簽名模式，您實現的回調函數都需要保證調用時Token、Signature的返回結果。如果您需要實現向業務Server獲取Token、Signature的網絡請求，建議調用網絡庫的同步接口。回調都是在SDK發起具體請求時，在請求的子線程中執行，所以不會阻塞主線程。

STS鑒權模式

通過STS臨時授權訪問OSS的步驟如下：

1. 獲取臨時訪問憑證

   臨時訪問憑證包括臨時訪問密鑰（AccessKey ID和AccessKey Secret）和安全令牌（SecurityToken）。臨時訪問憑證有效時間單位為秒，最小值為900，最大值以當前角色設定的最大會話時間為準。更多信息，請參見設置RAM角色最大會話時間。

   您可以通過以下兩種方式獲取臨時訪問憑證。

   • 方式一

     通過調用STS服務的AssumeRole接口獲取臨時訪問憑證。

   • 方式二

     通過各語言STS SDK獲取臨時訪問憑證。

2. 使用臨時訪問憑證初始化SDK

   id<OSSCredentialProvider> credential = [[OSSStsTokenCredentialProvider alloc] initWithAccessKeyId:@"<StsToken.AccessKeyId>" secretKeyId:@"<StsToken.SecretKeyId>" securityToken:@"<StsToken.SecurityToken>"];
   client = [[OSSClient alloc] initWithEndpoint:endpoint credentialProvider:credential];

   說明

   如果您需要使用OSSAuthCredentialProvider初始化SDK，請參見初始化。

   通過臨時訪問憑證初始化SDK時，需要注意StsToken的有效時間。以下代碼用于判斷StsToken的有效時間：

   NSDateFormatter * fm = [NSDateFormatter new];
   fm.locale = [NSLocale localeWithLocaleIdentifier:@"en_US_POSIX"];
   [fm setDateFormat:@"yyyy-MM-dd'T'HH:mm:ssZ"];
   NSDate *expirationDate = [fm dateFromString:@"<StsToken.Expiration>"];
   NSTimeInterval interval = [expirationDate timeIntervalSinceDate:[NSDate date]];
   // 即將過期，有效時間小于5分鐘。
   if (interval < 5 * 60) {
       id<OSSCredentialProvider> credential = [[OSSStsTokenCredentialProvider alloc] initWithAccessKeyId:@"<StsToken.AccessKeyId>" secretKeyId:@"<StsToken.SecretKeyId>" securityToken:@"<StsToken.SecurityToken>"];
       client = [[OSSClient alloc] initWithEndpoint:endpoint credentialProvider:credential];
   }

   • 手動更新StsToken

     當判斷StsToken即將過期時，您可以重新構造OSSClient，也可以通過如下方式更新CredentialProvider。

     id<OSSCredentialProvider> credential = [[OSSStsTokenCredentialProvider alloc] initWithAccessKeyId:@"<StsToken.AccessKeyId>" secretKeyId:@"<StsToken.SecretKeyId>" securityToken:@"<StsToken.SecurityToken>"];
     client = [[OSSClient alloc] initWithEndpoint:endpoint credentialProvider:credential];

   • 自動更新StsToken

     如果您期望SDK自動更新StsToken，那么您需要在SDK的應用中實現回調。通過您實現回調的方式去獲取Federation Token（即StsToken），SDK會使用此StsToken來進行加簽處理，并在需要更新時主動調用此回調來獲取StsToken。

     id<OSSCredentialProvider> credential = [[OSSFederationCredentialProvider alloc] initWithFederationTokenGetter:^OSSFederationToken * {
         // 您需要在此處實現獲取一個FederationToken，并構造成OSSFederationToken對象返回。
         // 如果由于某種原因獲取失敗，直接返回nil。
           OSSFederationToken * token;
         // 從您的服務器中獲取token。
         ...
         return token;
     }];
     client = [[OSSClient alloc] initWithEndpoint:endpoint credentialProvider:credential];

     說明

     如果您已經通過其他方式獲取了StsToken所需的各個字段，也可以在回調中直接返回StsToken。但您需要手動處理StsToken的更新，且更新后重新設置該OSSClient實例的OSSCredentialProvider。

     假設您訪問的Server地址為http://localhost:8080/distribute-token.json，則返回的數據如下：

     {
         "StatusCode": 200,
         "AccessKeyId":"STS.iA645eTOXEqP3cg3****",
         "AccessKeySecret":"rV3VQrpFQ4BsyHSAvi5NVLpPIVffDJv4LojU****",
         "Expiration":"2015-11-03T09:52:59Z",
         "SecurityToken":"CAES7QIIARKAAZPlqaN9ILiQZPS+JDkS/GSZN45RLx4YS/p3OgaUC+oJl3XSlbJ7StKpQ****"
     }                           

     實現OSSFederationCredentialProvider的示例如下。

     id<OSSCredentialProvider> credential2 = [[OSSFederationCredentialProvider alloc] initWithFederationTokenGetter:^OSSFederationToken * {
         // 構造請求訪問您的業務Server。
         NSURL * url = [NSURL URLWithString:@"http://localhost:8080/distribute-token.json"];
         // 通過request設置自有服務器需要的參數。
         NSURLRequest * request = [NSURLRequest requestWithURL:url];
         OSSTaskCompletionSource * tcs = [OSSTaskCompletionSource taskCompletionSource];
         NSURLSession * session = [NSURLSession sharedSession];
         // 發送請求。
         NSURLSessionTask * sessionTask = [session dataTaskWithRequest:request
                                                     completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                         if (error) {
                                                             [tcs setError:error];
                                                             return;
                                                         }
                                                         [tcs setResult:data];
                                                     }];
         [sessionTask resume];
         // 需要阻塞等待請求返回。
         [tcs.task waitUntilFinished];
         // 解析結果。
         if (tcs.task.error) {
             NSLog(@"get token error: %@", tcs.task.error);
             return nil;
         } else {
             // 返回數據為JSON格式，需要解析返回數據得到token的各個字段。
             NSDictionary * object = [NSJSONSerialization JSONObjectWithData:tcs.task.result
                                                                     options:kNilOptions
                                                                       error:nil];
             OSSFederationToken * token = [OSSFederationToken new];
             token.tAccessKey = [object objectForKey:@"AccessKeyId"];
             token.tSecretKey = [object objectForKey:@"AccessKeySecret"];
             token.tToken = [object objectForKey:@"SecurityToken"];
             token.expirationTimeInGMTFormat = [object objectForKey:@"Expiration"];
             NSLog(@"get token: %@", token);
             return token;
         }
     }];

簽名URL