Příklady kódu pro iOS/OS XiOS/OS X code examples

Toto téma vás seznámí s důležitými elementy kódu verze RMS SDK pro iOS/OS X.This topic will introduce you to important code elements for the iOS/OS X version of the RMS SDK.

Poznámka: V ukázkovém kódu a příkladech, které následují, v odkazech na klientský proces používáme termín MSIPC (Microsoft Information Protection and Control).Note In the example code and descriptions that follow, we use the term MSIPC (Microsoft Information Protection and Control) to reference the client process.

Použití sady Microsoft Rights Management SDK 4.2 – klíčové scénářeUsing the Microsoft Rights Management SDK 4.2 - key scenarios

Následují ukázky kódu Objective C z větší ukázkové aplikace, které reprezentují vývojové scénáře důležité pro vaši orientaci v této sadě SDK.Following are Objective C code examples from a larger sample application representing development scenarios important to your orientation to this SDK. Ukazují použití formátu Microsoft Protected File, na který se odkazuje jako na chráněný soubor, použití vlastních formátů chráněných souborů a použití vlastních ovládacích prvků uživatelského rozhraní.These demonstrate; use of Microsoft Protected File format referred to as protected file , use of custom protected file formats, and use of custom UI controls.

Scénář: Využití souboru chráněného RMSScenario: Consume an RMS protected file

  • Krok 1: Vytvoření objektu MSProtectedDataStep 1: Create an MSProtectedData object

    Popis: Vytvoříte instanci objektu MSProtectedData prostřednictvím jeho metody create, která implementuje ověřování služeb tak, že pomocí MSAuthenticationCallback získá token předáním MSAuthenticationCallback jako parametru authenticationCallback rozhraní MSIPC API.Description: Instantiate an MSProtectedData object, through its create method which implements service authentication using the MSAuthenticationCallback to get a token by passing an instance of MSAuthenticationCallback, as the parameter authenticationCallback, to the MSIPC API. Viz volání MSProtectedData protectedDataWithProtectedFile v následujícím ukázkovém kódu.See the call to MSProtectedData protectedDataWithProtectedFile in the following example code section.

      + (void)consumePtxtFile:(NSString *)path authenticationCallback:(id<MSAuthenticationCallback>)authenticationCallback
      {
          // userId can be provided as a hint for authentication
          [MSProtectedData protectedDataWithProtectedFile:path
                                               userId:nil
                               authenticationCallback:authenticationCallback
                                              options:Default
                                      completionBlock:^(MSProtectedData *data, NSError *error)
          {
              //Read the content from the ProtectedData, this will decrypt the data
              NSData *content = [data retrieveData];
          }];
      }
    
  • Krok 2: Ověření nastavení pomocí knihovny Active Directory Authentication Library (ADAL)Step 2: Setup authentication using the Active Directory Authentication Library (ADAL).

    Popis: V tomto kroku uvidíte, jak se knihovna ADAL použije k implementaci MSAuthenticationCallback s ukázkovými ověřovacími parametry.Description: In this step you will see ADAL used to implement an MSAuthenticationCallback with example authentication parameters. Další informace o použití knihovny ADAL najdete v tématu Azure AD Authentication Library (ADAL).For more information on using ADAL, see the Azure AD Authentication Library (ADAL).

    // AuthenticationCallback holds the necessary information to retrieve an access token.
    @interface MsipcAuthenticationCallback : NSObject<MSAuthenticationCallback>
    
    @end
    
    @implementation MsipcAuthenticationCallback
    
    - (void)accessTokenWithAuthenticationParameters:
           (MSAuthenticationParameters *)authenticationParameters
                                  completionBlock:
           (void(^)(NSString *accessToken, NSError *error))completionBlock
    {
        ADAuthenticationError *error;
        ADAuthenticationContext* context = [
            ADAuthenticationContext authenticationContextWithAuthority:authenticationParameters.authority
                                                              error:&error
        ];
        NSString *appClientId = @”com.microsoft.sampleapp”;
        NSURL *redirectURI = [NSURL URLWithString:@"local://authorize"];
        // Retrieve token using ADAL
        [context acquireTokenWithResource:authenticationParameters.resource
                               clientId:appClientId
                            redirectUri:redirectURI
                                 userId:authenticationParameters.userId
                        completionBlock:^(ADAuthenticationResult *result) {
                            if (result.status != AD_SUCCEEDED)
                            {
                                NSLog(@"Auth Failed");
                                completionBlock(nil, result.error);
                            }
                            else
                            {
                                completionBlock(result.accessToken, result.error);
                            }
                        }];
     }
    
  • Krok 3: Kontrola, jestli pro tohoto uživatele existují práva pro úpravy tohoto obsahu prostřednictvím metody MSUserPolicy accessCheck objektu MSUserPolicyStep 3: Check if the Edit right exists for this user with this content via the MSUserPolicy accessCheck method of a MSUserPolicy object.

    - (void)accessCheckWithProtectedData:(MSProtectedData *)protectedData
    {
        //check if user has edit rights and apply enforcements
        if (!protectedData.userPolicy.accessCheck(EditableDocumentRights.Edit))
        {
            // enforce on the UI
            textEditor.focusableInTouchMode = NO;
            textEditor.focusable = NO;
            textEditor.enabled = NO;
        }
    }
    

Scénář: Vytvoření nového chráněného souboru pomocí šablonyScenario: Create a new protected file using a template

Tento scénář začíná získáním seznamu šablon, MSTemplateDescriptor, pak se vybere první z nich pro vytvoření zásady a nakonec se vytvoří nový chráněný soubor a zapíše se do něj.This scenario begins with getting a list of templates, MSTemplateDescriptor, selecting the first one to create a policy, then creating and writing to the new protected file.

  • Krok 1: Získání seznamu šablonStep 1: Get list of templates

    + (void)templateListUsageWithAuthenticationCallback:(id<MSAuthenticationCallback>)authenticationCallback
    {
        [MSTemplateDescriptor templateListWithUserId:@"user@domain.com"
                        authenticationCallback:authenticationCallback
                               completionBlock:^(NSArray/*MSTemplateDescriptor*/ *templates, NSError *error)
                               {
                                 // use templates array of MSTemplateDescriptor (Note: will be nil on error)
                               }];
    }
    
  • Krok 2: Vytvoření MSUserPolicy pomocí první šablony v seznamuStep 2: Create a MSUserPolicy using the first template in the list.

    + (void)userPolicyCreationFromTemplateWithAuthenticationCallback:(id<MSAuthenticationCallback>)authenticationCallback
    {
        [MSUserPolicy userPolicyWithTemplateDescriptor:[templates objectAtIndex:0]
                                        userId:@"user@domain.com"
                                 signedAppData:nil
                        authenticationCallback:authenticationCallback
                                       options:None
                               completionBlock:^(MSUserPolicy *userPolicy, NSError *error)
        {
        // use userPolicy (Note: will be nil on error)
        }];
    }
    
  • Krok 3: Vytvoření MSMutableProtectedData a zápis obsahu do objektuStep 3: Create a MSMutableProtectedData and write content to it.

    + (void)createPtxtWithUserPolicy:(MSUserPolicy *)userPolicy contentToProtect:(NSData *)contentToProtect
    {
        // create an MSMutableProtectedData to write content
        [contentToProtect protectedDataInFile:filePath
                    originalFileExtension:kDefaultTextFileExtension
                           withUserPolicy:userPolicy
                          completionBlock:^(MSMutableProtectedData *data, NSError *error)
        {
         // use data (Note: will be nil on error)
        }];
    }
    

Scénář: Otevření vlastního chráněného souboruScenario: Open a custom protected file

  • Krok 1: Vytvoření MSUserPolicy na základě serializedContentPolicyStep 1: Create a MSUserPolicy from a serializedContentPolicy.

    + (void)userPolicyWith:(NSData *)protectedData
    authenticationCallback:(id<MSAuthenticationCallback>)authenticationCallback
    {
        // Read header information from protectedData and extract the  PL
        /*-------------------------------------------
        | PL length | PL | ContetSizeLength |
        -------------------------------------------*/
        NSUInteger serializedPolicySize;
        NSMutableData *serializedPolicy;
        [protectedData getBytes:&serializedPolicySize length:sizeof(serializedPolicySize)];
        [protectedData getBytes:[serializedPolicy mutableBytes] length:serializedPolicySize];
    
        // Get the user policy , this is an async method as it hits the REST service
        // for content key and usage restrictions
        // userId provided as a hint for authentication
        [MSUserPolicy userPolicyWithSerializedPolicy:serializedPolicy
                                          userId:@"user@domain.com"
                          authenticationCallback:authenticationCallback
                                         options:Default
                                 completionBlock:^(MSUserPolicy *userPolicy,
                                                   NSError *error)
        {
    
        }];
     }
    
  • Krok 2: Vytvoření MSCustomProtectedData pomocí MSUserPolicy z kroku 1 a čtení z nějStep 2: Create a MSCustomProtectedData using the MSUserPolicy from Step 1 and read from it.

    + (void)customProtectedDataWith:(NSData *)protectedData
    {
        // Read header information from protectedData and extract the  protectedContentSize
        /*-------------------------------------------
        | PL length | PL | ContetSizeLength |
        -------------------------------------------*/
        NSUInteger protectedContentSize;
        [protectedData getBytes:&protectedContentSize
                     length:sizeof(protectedContentSize)];
    
        // Create the MSCustomProtector used for decrypting the content
        // The content start position is the header length
        [MSCustomProtectedData customProtectedDataWithPolicy:userPolicy
                                           protectedData:protectedData
                                    contentStartPosition:sizeof(NSUInteger) + serializedPolicySize
                                             contentSize:protectedContentSize
                                         completionBlock:^(MSCustomProtectedData *customProtector,
                                                           NSError *error)
        {
         //Read the content from the custom protector, this will decrypt the data
         NSData *content = [customProtector retrieveData];
         NSLog(@"%@", content);
        }];
     }
    

Scénář: Vytvoření vlastního chráněného souboru pomocí vlastních zásady (ad hoc)Scenario: Create a custom protected file using a custom (ad-hoc) policy

  • Krok 1: Vytvoření popisu zásad s e-mailovou adresou, kterou poskytl uživatelStep 1: With an email address provided by the user, create a policy descriptor.

    Popis: V praxi by se následující objekty vytvořily s použitím uživatelského vstupu z rozhraní zařízení: MSUserRights a MSPolicyDescriptor.Description: In practice the following objects would be created by using user inputs from the device interface; MSUserRights and MSPolicyDescriptor.

    + (void)policyDescriptor
    {
        MSUserRights *userRights = [[MSUserRights alloc] initWithUsers:[NSArray arrayWithObjects: @"user1@domain.com", @"user2@domain.com", nil] rights:[MSEmailRights all]];
    
        MSPolicyDescriptor *policyDescriptor = [[MSPolicyDescriptor alloc] initWithUserRights:[NSArray arrayWithObjects:userRights, nil]];
        policyDescriptor.contentValidUntil = [[NSDate alloc] initWithTimeIntervalSinceNow:NSTimeIntervalSince1970 + 3600.0];
        policyDescriptor.offlineCacheLifetimeInDays = 10;
    }
    
  • Krok 2: Vytvoření vlastní třídy MSUserPolicy z popisu zásad selectedDescriptorStep 2: Create a custom MSUserPolicy from the policy descriptor, selectedDescriptor.

    + (void)userPolicyWithPolicyDescriptor:(MSPolicyDescriptor *)policyDescriptor
    {
        [MSUserPolicy userPolicyWithPolicyDescriptor:policyDescriptor
                                      userId:@"user@domain.com"
                      authenticationCallback:authenticationCallback
                                     options:None
                             completionBlock:^(MSUserPolicy *userPolicy, NSError *error)
        {
          // use userPolicy (Note: will be nil on error)
        }];
    }
    
  • Krok 3: Vytvoření a zápis obsahu do objektu MSMutableCustomProtectedData a zavření objektuStep 3: Create and write content to the MSMutableCustomProtectedData and then close.

    + (void)mutableCustomProtectedData:(NSMutableData *)backingData policy:(MSUserPolicy *)policy contentToProtect:(NSString *)contentToProtect
    {
        //Get the serializedPolicy from a given policy
        NSData *serializedPolicy = [policy serializedPolicy];
    
        // Write header information to backing data including the PL
        // ------------------------------------
        // | PL length | PL | ContetSizeLength |
        // -------------------------------------
        NSUInteger serializedPolicyLength = [serializedPolicy length];
        [backingData appendData:[NSData dataWithBytes:&serializedPolicyLength length:sizeof(serializedPolicyLength)]];
        [backingData appendData:serializedPolicy];
        NSUInteger protectedContentLength = [MSCustomProtectedData getEncryptedContentLengthWithPolicy:policy contentLength:unprotectedData.length];
        [backingData appendData:[NSData dataWithBytes:&protectedContentLength length:sizeof(protectedContentLength)]];
    
        NSUInteger headerLength = sizeof(serializedPolicyLength) + serializedPolicyLength + sizeof(protectedContentLength);
    
        // Create the MSMutableCustomProtector used for encrypting content
        // The content start position is the current length of the backing data
        // The encryptedContentSize content size is 0 since there is no content yet
        [MSMutableCustomProtectedData customProtectorWithUserPolicy:policy
                                                    backingData:backingData
                                         protectedContentOffset:headerLength
                                                completionBlock:^(MSMutableCustomProtectedData *customProtector,
                                                                  NSError *error)
        {
            //Append data to the custom protector, this will encrypt the data and write it to the backing data
            [customProtector appendData:[contentToProtect dataUsingEncoding:NSUTF8StringEncoding] error:&error];
    
            //close the custom protector so it will flush and finalise encryption
            [customProtector close:&error];
    
        }];
      }
    

KomentářeComments

Před přidáním komentáře se podívejte na naše pravidla organizace.Before commenting, we ask that you review our House rules.