IRM SDK

Beta Version 4.5.1 Release Notes

December 2008
The IRM Server SDK contains management, extension, client integration, and decryption
APIs that allow you to enhance the capabilities of the IRM Server. Specifically, these APIs
allow you to automate management functions, write extensions to enhance the IRM Server’s
authorization architecture, and integrate your own application (including decryption
capability). An application developed or enhanced using the Content Protection or Client
Integration API is considered to be an IRM enabled application.

For more information about IRM products, visit our web site at:

http://software.emc.com/products/product_family/documentum_family.htm#9

1. Contents
This document provides details about supported platforms and known issues with the various
APIs that comprise the IRM SDK.
What's New?
Supported Platforms and System Requirements
Installing the SDK
Using the IRM Common Installer
Using the Client Integration API
Using the IRM Content Decryption API
Registering Applications
Features Not Supported in This Beta Release

Copyright © 2008 EMC Corporation. All rights reserved.

EMC, and any logos associated therewith, are trademarks or registered trademarks of EMC Corporation in the United States and other countries. All other product names
mentioned herein may be trademarks or registered trademarks of their respective companies.
300-xxx-xxx-A01
2. What's New?
The IRM SDK includes these APIs:
 IRM Server Management API for C
 IRM Server Management API for COM
 IRM Server Extensions API for COM
 IRM Client Integration API for C
 IRM Content Decryption API for COM

This is the third Beta release of the IRM SDK. Changes since the last beta release include:
 Unlike the previous beta releases, this release of the SDK requires the beta version
of IRM Server V4.5.1.
 Any protected content produced using a previous beta release of the Client
Integration API is incompatible with this release.
 An SDK installer has been implemented.
 An IRM Common installer is available for application installations.
 Application authentication is available.
 Client Integration API features, screen capture defeat and support for application
permissions, are available.
 Content Protection API features, support for content protected by the Client
Integration API and authentication other than shared secret, are available.
 The decryption service entry, ProgrammaticDecrypt, is automatically entered in the
list of client types on the IRM Server.
 Document-level AES protection (for PDF documents) is available with the Content
Decryption API; however, the saved document is not linearized. This issue is being
researched.

3. Supported Platforms and System Requirements

The IRM SDK supports the following operating systems:
 Windows 2003 Server SP2
 Windows XP SP2 or SP3

4. Installing the SDK

The following procedure is a high-level overview of the steps needed to integrate the SDK in
your application build environment.
1. Install the SDK package on the application developer’s system by starting EMC IRM
SDK.exe.
2. Add the SDK include path to the list for the application build environment. For the Client
Integration and Content Decryption APIs, this is EMC IRM SDK/Client/include.
3. Add the SDK library path to the list for the application build environment. For the Client
Integration API, this is EMC IRM SDK/Client/lib.
4. Add the SDK libraries to the link command for the application build environment. For the
Client Integration API, this is libpvsapi.lib.

Page 2 of 4
5. Using the IRM Common Installer
The IRM Common installer is used with IRM enabled applications to install IRM specific
features, such as autooffline and registering the Content Decryption library. After developing
an IRM enabled application, you can incorporate the IRM Common.exe file into your
application installer. To perform a silent install of the IRM Common installer, use the following
command:
"IRM Common.exe" /s /v"/qn"
Note that there is no space between /v and "/qn". You can perform a silent uninstall of the
IRM Common installer with the following command:
"IRM Common.exe" /x /s /v"/qn"

6. Using the Client Integration API

The EMC IRM products protect Adobe PDF and Microsoft Office documents. You can use the
Client Integration API to protect content in a different format, such as CAD. To use the API,
install the SDK then implement callback routines for memory allocation, memory deallocation,
IO, and watermark processing. As a starting point, use the example program,
ContentSDKExample.c, which is provided with the SDK installation kit.

For information on the various functions, see the associated online help system.

7. Using the IRM Content Decryption API

See the example program, DocDecrypt.cpp. For information on the various functions, see the
associated online help system.

8. Registering Applications
Once an application is developed using the Client Integration or Content Decryption API, you
need to generate an XML file that contains the application name, a certificate chain, types of
content, any custom permissions, and any language support. This file must be registered with
the IRM Server in order for IRM users to protect or decrypt content with the application. Refer
to the IRM Server Administrator's Guide for the procedure.

Using the ContentSDKExample.xml file provided with the SDK kit as a template, complete the
following:
1. Enter the Version of the application using <IrmVendor version> tag.
2. Add a certificate chain from root to end using the <CertChain> tag. Use the
<CertRevURL> tag to specify the URL by which certificate revocation can be checked.
3. Determine the type of content that this application can process. For example, the
application may handle JPG and text files.

Page 3 of 4
 4. Use the <ContentType> set of tags. The <MimeType> tag specifies the type of content.
The <Permission> tag can specify permissions (other than print, copy, and edit) unique
to this application. You can use multiple <Permission> tags to define multiple
permissions.
Permission identifiers are to be of the form x.y, where x is content-related namespace
such as "cad" and y is the permission name. Only letters, digits, and underscores are
allowed in permission identifiers. There can only be one period as indicated.
5. If this application can process more than one type of content, use the <ContentType>,
<MimeType>, and <Permission> tags to define each type of content.
6. Optionally, you can support multiple languages. The <Language> tags provide
language-specific display names for the supported permissions.
The <Name> tag supplies the standard language identifier of the language. The
<Name> tag, under the <Permission> tag, specifies a permission previously defined
under <Content Type>. The <Display> tag provides the translated string to display in the
user interface.
If the application user is using a language for which no display name is specified,
English will be used; failing that, the permission identifier will be used as the display
name.
7. Each language must be defined with its own <Language> tag.
8. Once the file is complete, register the file with the IRM Server as described in the IRM
Server Administrator’s Guide.

9. Features Not Supported in This Beta Release

The beta release of the Client Integration API does not support the following features:
 Offline access support.
 Audit events other than EMC audit events.
 In the IRMContentOpenParms Structure, the IRMContentAccCtx * relatedContent
parameter is not supported. This is the access context for a content to which the
protected content being produced is related (write mode only).

Page 4 of 4