Expand Minimize

ConfigureAuthenticatedChannel(D3D11_1) routine

Processes a request from an application to configure an authenticated channel for content protection. Implemented by a Windows Display Driver Model (WDDM) 1.2 or later user-mode display driver.

Syntax


HRESULT APIENTRY* ConfigureAuthenticatedChannel(
  _In_        D3D10DDI_HDEVICE                          hDevice,
  _In_        D3D11_1DDI_HAUTHCHANNEL                   hCAuthChannel,
  _In_        UINT                                      InputDataSize,
  _In_  const VOID                                      *pInputData,
  _Out_       D3D11_1DDI_AUTHENTICATED_CONFIGURE_OUTPUT *pOutputData
);

Parameters

hDevice [in]

A handle to the display device (graphics context).

hCAuthChannel [in]

A handle to the authenticated channel object that was created through a call to the CreateAuthenticatedChannel(D3D11_1) function.

InputDataSize [in]

The size, in bytes, of the array that is specified by the pInputData parameter.

pInputData [in]

A pointer to a byte array that contains input data for the command. For more information, see the Remarks section.

pOutputData [out]

A pointer to a D3D11_1DDI_AUTHENTICATED_CONFIGURE_OUTPUT structure. For more information, see the Remarks section.

Return value

Returns one of the following values:

Return codeDescription
S_OK

The authenticated channel was configured successfully.

E_FAIL

The display miniport driver does not support the specified command

E_INVALIDARG

Parameters were validated and determined to be incorrect.

E_OUTOFMEMORY

Memory was not available to complete the operation.

 

Remarks

The byte array that is referenced by the pInputData parameter is formatted in the following way:

The D3D11_1DDI_AUTHENTICATED_CONFIGURE_INPUT structure contains an AES-based one-key CBC message authentication code (OMAC) of the data. The display miniport driver must calculate its own OMAC over the data to authenticate the data. This input structure also contains a driver handle to the authenticated channel, a sequence number, and a GUID that indicates the configuration type.

The display miniport driver follows these steps when it initializes the D3D11_1DDI_AUTHENTICATED_CONFIGURE_OUTPUT structure:

  1. The driver must copy the input data to the D3D11_1DDI_AUTHENTICATED_CONFIGURE_OUTPUT structure.

  2. The driver must set the ReturnCode member to the same return code that it will return for the ConfigureAuthenticatedChannel(D3D11_1) call. This provides the application with a secure mechanism of accessing the return code.

  3. The driver sets the omac member to zero and then calculates an OMAC for the data in the structure. The driver then sets the omac member to the OMAC that it calculated.

The display miniport driver must return E_INVALIDARG for the ConfigureAuthenticatedChannel call under the following conditions:

  • The omac member of the D3D11_1DDI_AUTHENTICATED_CONFIGURE_INPUT structure does not match the OMAC that the driver calculated.

  • The sequence number is not greater than a sequence number that was specified in a previous configuration call.

  • The sequence number has not yet been initialized by a call to the ConfigureAuthenticatedChannel(D3D11_1) function.

  • The InputDataSize parameter is less than the size of the D3D11_1DDI_AUTHENTICATED_CONFIGURE_INPUT structure plus the size of the structure specified by the D3D11_1DDI_AUTHENTICATED_CONFIGURE_INPUT.ConfigureType member.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Target platform

Desktop

Header

D3d10umddi.h (include D3d10umddi.h)

See also

CreateAuthenticatedChannel(D3D11_1)
D3D11_1DDI_AUTHENTICATED_CONFIGURE_INPUT
D3D11_1DDI_AUTHENTICATED_CONFIGURE_OUTPUT

 

 

Send comments about this topic to Microsoft

Show:
© 2015 Microsoft