Share via

HTTP and SOAP Provider::PassportEncrypt

  • Article

Wrapper for the Passport.Crypt object. Used by Microsoft Provisioning Framework (MPF) to encrypt information in a provisioning request before passing it to a Microsoft .NET Passport site.

Arguments

The following table describes the XML schema elements and attributes. Unless otherwise indicated, the data type is string.

Element Description, relationships, and attributes

executeData

Description:
Encapsulates the procedure's input and output data.

Children:
requestInfo result

encryption

Description:
Encapsulates the response from the remote server, which contains the siteId and keyVersion as well as the encrypted data.

Parent:
result

Children:
keyVersion (minOccurs="1" maxOccurs="1")
siteId (minOccurs="1" maxOccurs="1")
text (minOccurs="1" maxOccurs="1")

keyVersion

Description:
Public key for encryption. Required whenever siteId is used.

Parent:
requestInfo, encryption

Maximum Length:
16

requestInfo

Description:
Encapsulates the information the Providers [HMC SDK] uses to encrypt the request.

Parent:
executeData

Children:
keyVersion (minOccurs="0" maxOccurs="1")
siteId (minOccurs="0" maxOccurs="1")
text (minOccurs="0" maxOccurs="1")

result

Description:
Encapsulates the response from the remote server.

Parent:
executeData

Children:
encryption (minOccurs="1" maxOccurs="1")

siteId

Description:
.NET Passport site ID created by installation of the partner key.

Parent:
requestInfo, encryption

Maximum Length:
16

text

Description:
Data to be encrypted.

Parent:
requestInfo, encryption

Maximum Length:
4,096

Remarks

No remarks.

Schema Definition

Input

<executeData>1..1
  <requestInfo>1..1
    <siteId>0..1</siteId>
    <keyVersion>0..1</keyVersion>
    <text>1..1</text>
  </requestInfo>
  <result>0..1</result>
</executeData>

Output

<executeData>1..1
  <result>1..1
    <encryption>
      <siteId>1..1</siteId>
      <keyVersion>1..1</keyVersion>
      <text>1..1</text>
    </encryption>
  </result>
</executeData>

Sample Code

Example XML Request

The following code fragment shows the format for sending data to this procedure. For more information on individual elements and attributes, see the Elements and Attributes table.

Example XML Response

The following code fragment shows the format for data this procedure returns. For more information on individual elements and attributes, see the Elements and Attributes table.

Applies To

HTTP and SOAP Provider for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

  • Hosted Messaging and Collaboration version 3.5

  • Hosted Messaging and Collaboration version 3.0

  • Windows-based Hosting version 4.5

  • Windows-based Hosting version 4.0

  • Windows-based Hosting version 3.5

  • Windows-based Hosting for Applications version 1.0