Integrate the iOS SDK

iOS SDK files

Contact Alibaba Cloud technical support to obtain and decompress the SDK package. The decompressed sdk-iOS folder contains the following files:

Configure the iOS project

1. In your project, go to the Build Phases tab, select Link Binary With Libraries, and add the following four .framework dependency files from the SDK package:

   • SGMain.framework

   • SecurityGuardSDK.framework

   • SGSecurityBody.framework

   • SGAVMP.framework

2. On the Build Settings tab, set Linking > Other Linker Flags to -ObjC.

3. Add the following system dependency files to your project's dependency library:

   • CoreFoundation.framework

   • CoreLocation.framework

   • AdSupport.framework

   • CoreTelephony.framework

   • CoreMotion.framework

   • SystemConfiguration.framework

   You must also add libz.1.2.8.tbd.

4. Add the yw_1222_0335_mwua.jpg configuration file from the SDK package to the mainbundle directory.

   Important

   If your application integrates multiple targets, add the yw_1222_0335_mwua.jpg configuration file to the correct Target Membership.

Call the SDK API

Step 1: Initialize the SDK

API definition: + (BOOL) initialize;

Description: Initializes the SDK.

Parameters: None.

Return value: A Boolean value. Returns YES on success or NO on failure.

Example call: [JAQAVMPSignature initialize];

static BOOL avmpInit = NO;
- (BOOL) initAVMP{
  @synchronized(self) { // just initialize once
    if(avmpInit == YES){
      return YES; 
    }
    avmpInit = [JAQAVMPSignature initialize];
    return avmpInit; 
  }
}

Step 2: Sign request data

API definition: + (NSData*) avmpSign: (NSInteger) signType input: (NSData*) input;

Return value: An NSData* object that contains the signature string.

Example call: [JAQAVMPSignature avmpSign: 3 input: request_body];

# define VMP_SIGN_WITH_GENERAL_WUA2 (3)
- (NSString*) avmpSign{
  @synchronized(self) {
    NSString* request_body = @"The request body, which can be encrypted or plaintext.";
    if(![self initAVMP]){
      [self toast:@"Error: init failed"];
        return nil;
    }
    NSString* wToken = nil;
    NSData* data = [request_body dataUsingEncoding:NSUTF8StringEncoding];
    NSData* sign = [JAQAVMPSignature avmpSign: VMP_SIGN_WITH_GENERAL_WUA2 input:data];
    if(sign == nil || sign.length <= 0){
      return nil;
    }else{
      wToken = [[NSString alloc] initWithData:sign encoding: NSUTF8StringEncoding];
      return wToken;
    }
  }
}

NSData* sign = [JAQAVMPSignature avmpSign: VMP_SIGN_WITH_GENERAL_WUA2 input:nil];

Step 3: Add the wToken to the header

#define VMP_SIGN_WITH_GENERAL_WUA2 (3)
-(void)setHeader
{ NSString* request_body = @"The request body, which can be encrypted or plaintext.";
  NSData* body_data = [request_body dataUsingEncoding:NSUTF8StringEncoding];
  NSString* wToken = nil;
  NSData* sign = [JAQAVMPSignature avmpSign: VMP_SIGN_WITH_GENERAL_WUA2 input:body_data];
  wToken = [[NSString alloc] initWithData:sign encoding: NSUTF8StringEncoding];
  NSString *strUrl = [NSString stringWithFormat:@"http://www.aliyundoc.com/login"];
  NSURL *url = [NSURL URLWithString:strUrl];
  NSMutableURLRequest *request =
    [[NSMutableURLRequest alloc]initWithURL:url cachePolicy:NSURLRequestReloadIgnoringCacheData timeoutInterval:20];
  [request setHTTPMethod:@"POST"];
  // Set the request body.
  [request setHTTPBody:body_data];
  // Add the wToken to the header.
  [request setValue:wToken forHTTPHeaderField:@"wToken"];
  NSURLConnection *mConn = [[NSURLConnection alloc]initWithRequest:request delegate:self startImmediately:true];
  [mConn start]; 
  // ...
}

Step 4: Send the data to the server

Send the request with the modified header to Alibaba Cloud Security. Alibaba Cloud Security parses the wToken to identify risks and block malicious requests, then forwards legitimate requests to the origin server.

Error codes

If an exception occurs or signature generation fails, search the console log for SG Error to find the corresponding error code.

The following table lists common error codes.