Alibaba Cloud OSS SDK for iOS

For mobile applications, it is recommended to use STS (Security Token Service) authentication. You can initialize an OSSAuthCredentialProvider with an STS URL, which automatically fetches and updates credentials.

Requirements:

• Use an endpoint with the https:// prefix to comply with Apple's ATS policy (supported from V2.6.0+).
• Ensure your app does not send non-HTTPS requests during signing or STSToken callbacks.

#include <AliyunOSSiOS/AliyunOSSiOS.h>

// ... inside your implementation ...

- (void)setupOSSClient {
    // initialize credential provider, which auto fetch and update sts info from sts url.
    OSSAuthCredentialProvider *credentialProvider = [[OSSAuthCredentialProvider alloc] initWithAuthServerUrl:OSS_STS_URL];
    
    // set config for oss client networking
    OSSClientConfiguration *cfg = [[OSSClientConfiguration alloc] init];
    
    _client = [[OSSClient alloc] initWithEndpoint:OSS_ENDPOINT credentialProvider:credentialProvider clientConfiguration:cfg];
}

To manually include the framework, you can build it from the source repository:

1. Clone the repository.
2. Run the packaging script to generate the AliyunOSSiOS.framework.
3. In Xcode, drag and drop the generated framework into your target and select Copy items if needed.

Important Configuration:

• Add -ObjC to your project's Other Linker Flags in Build Settings.
• If your project uses -force_load, add -force_load <framework path>/AliyunOSSiOS.

IPv6-Only Compatibility (V2.5.0+): If your app must support IPv6-only networks, you must also include these system libraries:

• libresolv.tbd
• SystemConfiguration.framework
• CoreTelephony.framework

# Clone the project
$ git clone git@github.com:aliyun/aliyun-oss-ios-sdk.git

# Enter the directory
$ cd aliyun-oss-ios-sdk

# Run the packaging script
$ sh ./buildiOSFramework.sh

# Enter the generated packaging directory where the AliyunOSSiOS.framework will be generated
$ cd Products && ls

To upload data, create an OSSPutObjectRequest, specify the bucket and object key, and provide the data via uploadingData. The operation returns an OSSTask which can be handled asynchronously via a continuation block or synchronously via waitUntilFinished.

OSSPutObjectRequest * put = [OSSPutObjectRequest new];

put.bucketName = @"<bucketName>";
put.objectKey = @"<objectKey>";

put.uploadingData = <NSData *>; // Directly upload NSData

put.uploadProgress = ^(int64_t bytesSent, int64_t totalByteSent, int64_t totalBytesExpectedToSend) {
    NSLog(@"%lld, %lld, %lld", bytesSent, totalByteSent, totalBytesExpectedToSend);
};

OSSTask * putTask = [client putObject:put];

[putTask continueWithBlock:^id(OSSTask *task) {
    if (!task.error) {
        NSLog(@"upload object success!");
    } else {
        NSLog(@"upload object failed, error: %@", task.error);
    }
    return nil;
}];

To download an object as NSData, create an OSSGetObjectRequest and specify the bucket and object key. The resulting OSSTask provides the downloaded data in its result property (as an OSSGetObjectResult).

OSSGetObjectRequest * request = [OSSGetObjectRequest new];
request.bucketName = @"<bucketName>";
request.objectKey = @"<objectKey>";

request.downloadProgress = ^(int64_t bytesWritten, int64_t totalBytesWritten, int64_t totalBytesExpectedToWrite) {
    NSLog(@"%lld, %lld, %lld", bytesWritten, totalBytesWritten, totalBytesExpectedToWrite);
};

OSSTask * getTask = [client getObject:request];

[getTask continueWithBlock:^id(OSSTask *task) {
    if (!task.error) {
        NSLog(@"download object success!");
        OSSGetObjectResult * getResult = task.result;
        NSLog(@"download result: %@", getResult.downloadedData);
    } else {
        NSLog(@"download object failed, error: %@", task.error);
    }
    return nil;
}];