OnlineSigning_Callback.cpp

[The AD RMS SDK leveraging functionality exposed by the client in Msdrm.dll is available for use in Windows Server 2008, Windows Vista, Windows Server 2008 R2, Windows 7, Windows Server 2012, and Windows 8. It may be altered or unavailable in subsequent versions. Instead, use Active Directory Rights Management Services SDK 2.1, which leverages functionality exposed by the client in Msipc.dll.]

The following example shows a custom callback function that will be called by DRMGetSignedIssuanceLicense during online signing. In this example, a blocking event object is created in OnlineSigning_Main.cpp prior to calling the DRMGetSignedIssuanceLicense function. DRMGetSignedIssuanceLicense is an asynchronous function that returns control immediately to the _tmain function and continues processing on another thread, periodically calling into your callback with status information that you can filter and report back to the user. After the issuance license has been signed, this example processes the S_DRM_COMPLETED value and calls the SetEvent function to unblock the primary process thread. The issuance license is copied to new memory pointed to by the pwszData parameter of the Drm_Context structure.

#include "OnlineILSigning.h"

/*===================================================================
File:      OnlineSigning_Callback.cpp

THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF
ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE.

Copyright (C) Microsoft.  All rights reserved.
===================================================================*/

/////////////////////////////////////////////////////////////////////
// User-defined function to be called by the asynchronous AD RMS 
// DRMGetSignedIssuanceLicense function called in the 
// OnlineILSigning.cpp file. The callback function must have the 
// following signature, but you can use the function to perform 
// whatever action your application requires. Typically, you use the
// callback to relay the status of an AD RMS operation to the 
// end-user.
//
HRESULT __stdcall StatusCallback( 
               DRM_STATUS_MSG msg, 
               HRESULT hr, 
               void *pvParam, 
               void *pvContext )
{
  // Cast the pvContext (void*) argument to point to a Drm_Context
  // structure and verify that the argument is not NULL.
  PDRM_CONTEXT pContext = (PDRM_CONTEXT)pvContext;
  if (!pContext) return E_FAIL;

  // Initialize the hr member of the Drm_Context structure by using
  // the HRESULT value passed to the callback by the AD RMS
  // function. If the HRESULT passed to the callback is not S_OK,
  // and the Drm_Context structure contains a valid event handle,
  // signal the event and return.
  pContext->hr = hr;
  if (FAILED(pContext->hr) && pContext->hEvent )
  {
    SetEvent((HANDLE)pContext->hEvent);
    return S_OK;
  }

  // Print the callback status message to the console.
  switch(msg)
  {
    case DRM_MSG_SIGN_ISSUANCE_LICENSE:
      wprintf(L"\nCallback msg = DRM_MSG_SIGN_ISSUANCE_LICENSE ");
      break;
    default:
      wprintf(L"\nDefault callback status msg = 0x%x ", msg);
      break;
  }

  // Print the callback error code to the console.
  switch(pContext->hr)
  {
    case S_DRM_CONNECTING:
      wprintf(L"Callback hr = S_DRM_CONNECTING\n");
      break;
    case S_DRM_CONNECTED:
      wprintf(L"Callback hr = S_DRM_CONNECTED\n");
      break;
    case S_DRM_INPROGRESS:
      wprintf(L"Callback hr = S_DRM_INPROGRESS\n");
      break;
    case S_DRM_COMPLETED:
      // If the issuance license has been signed, the string that
      // contains the license will be pointed to by the pvParam
      // argument. Retrieve the license, allocate memory for it,
      // copy the license to memory, and assign the pointer to 
      // the pwszData member of the Drm_Context structure. The
      // function that created the structure must delete the
      // memory when finished with the license.
      wprintf(L"Callback hr = S_DRM_COMPLETED\n");
      pContext->hr = S_OK;
      if((DRM_MSG_SIGN_ISSUANCE_LICENSE == msg) && pvParam)
      {
        if (NULL != pvParam)
        {
          size_t uiSignedILLength = 0;
          hr = StringCchLength(
                  (PWSTR)pvParam, 
                  STRSAFE_MAX_CCH, 
                  &uiSignedILLength);
          if(FAILED(hr))
          {
            wprintf( L"StringCchLengthW failed.  hr = 0x%x\n", hr );
            break;
          }

          pContext->pwszData = new WCHAR[ uiSignedILLength + 1 ];
          if(NULL == pContext->pwszData) 
          {
            wprintf(L"Failed to allocate memory "\
                    L"for the signed issuance license.\n" );
            hr = E_OUTOFMEMORY;
            break;
          }

          hr = StringCchCopy(
                  (wchar_t*)pContext->pwszData, 
                  uiSignedILLength + 1 , 
                  (PWSTR)pvParam);
          if(FAILED(hr))
          {
            wprintf( L"StringCchCopyW failed.  hr = 0x%x\n", hr );
            break;
          }
        }
      }
     if(pContext->hEvent)
     {
        SetEvent((HANDLE)pContext->hEvent);
      }
        break;
    case E_DRM_ALREADY_IN_PROGRESS:
      wprintf( L"Callback hr = E_DRM_ALREADY_IN_PROGRESS\n" );
      break;
    case E_DRM_NO_CONNECT:
      wprintf( L"Callback hr = E_DRM_NO_CONNECT\n" );
      break;
    case E_DRM_ABORTED:
      wprintf( L"Callback hr = E_DRM_ABORTED\n" );
      break;
    case E_DRM_SERVER_ERROR:
      wprintf( L"Callback hr = E_DRM_SERVER_ERROR\n" );
      break;
    case E_DRM_INVALID_SERVER_RESPONSE:
      wprintf( L"Callback hr = E_DRM_INVALID_SERVER_RESPONSE\n" );
      break;
    case E_DRM_SERVER_NOT_FOUND:
      wprintf( L"Callback hr = E_DRM_SERVER_NOT_FOUND\n" );
      break;
    case E_DRM_AUTHENTICATION_FAILED:
      wprintf( L"Callback hr = E_DRM_AUTHENTICATION_FAILED\n" );
      break;
    case E_DRM_REQUEST_DENIED:
      wprintf( L"Callback hr = E_DRM_REQUEST_DENIED\n" );
      break;
    case E_DRM_SERVICE_GONE:
      wprintf( L"Callback hr = E_DRM_SERVICE_GONE\n" );
      break;
    case E_DRM_SERVICE_MOVED:
      wprintf( L"Callback hr = E_DRM_SERVICE_MOVED\n" );
      break;
    case E_DRM_VALIDITYTIME_VIOLATION:
      wprintf( L"Callback hr = E_DRM_VALIDITYTIME_VIOLATION\n" );
      break;
    case S_DRM_REQUEST_PREPARED:
      wprintf( L"Callback hr = S_DRM_REQUEST_PREPARED\n" );
      break;
    case E_DRM_NO_LICENSE:
      wprintf( L"Callback hr = E_DRM_NO_LICENSE\n" );
      break;
    case E_DRM_SERVICE_NOT_FOUND:
      wprintf( L"Callback hr = E_DRM_SERVICE_NOT_FOUND\n" );
      break;
    default:
      wprintf( L"Default callback hr = 0x%x\n", hr );
      pContext->hr = S_OK;
      if (pContext->hEvent)
      {
        SetEvent((HANDLE)pContext->hEvent);
      }
      break;
  }
  return S_OK;
}

Creating and Using Issuance Licenses

Online Signing Code Example