Password Protected Package

Return to types list

Type Properties

Properties
PropertyValue
idc9287326-bb43-4194-858c-8b60768f000f
namePassword Protected Package
uncreatablefalse
immutablefalse
singletonfalse
transformsform, mtt, stt
allow-readonlytrue

Type Details

password-protected-package  Defines the schema for a package that can contain a password encrypted blob.
NameTypeIsRequiredDescription
encrypt-algorithmpackage:PackageEncryptionTypeYesAlgorithm used in the encryption
PbeParametersType
NameTypeIsRequiredDescription
saltstringYesSalt used when hashing the value. The value for this element is application dependent, but to support consistency we suggest that the salt be a base64 encoded series of bytes matching the length requirement of the algorithm. For instance, 64 bytes for sha1 and sha256.
iteration-countintYesThe number of iterations used when hashing the data.
key-lengthintYesThe key length in bits used. The value depends on encryption algorithm. The default is 168 for 3DES and 256 for aes256.
PackageEncryptionType
NameTypeIsRequiredDescription
algorithm-name Yes 
parameterspackage:PbeParametersTypeNoParameters used by the algorithm for the encryption.

Schema

Open schema as a file

Verify XML against this schema

<?xml version="1.0" encoding="utf-16"?>
<schema xmlns:package="urn:com.microsoft.wc.thing.password.protected.package" targetNamespace="urn:com.microsoft.wc.thing.password.protected.package" xmlns="http://www.w3.org/2001/XMLSchema">
  <annotation>
    <documentation>
      <type-id xmlns="http://www.w3.org/2001/XMLSchema">c9287326-bb43-4194-858c-8b60768f000f</type-id>
      <type-name xmlns="http://www.w3.org/2001/XMLSchema">Password Protected Package</type-name>
      <uses-blob-store xmlns="http://www.w3.org/2001/XMLSchema">true</uses-blob-store>
      <wrapper-class-name xmlns="http://www.w3.org/2001/XMLSchema">PasswordProtectedPackage</wrapper-class-name>
      <wrapper-class-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136200</wrapper-class-fwlink>
      <sample-xml-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136201</sample-xml-fwlink>
      <data-type-guide-fwlink xmlns="http://www.w3.org/2001/XMLSchema">136199</data-type-guide-fwlink>
      <summary xmlns="http://www.w3.org/2001/XMLSchema">
                Defines the schema for a package that can contain a pkcs5v2 encrypted blob.
            </summary>
    </documentation>
  </annotation>
  <complexType name="PbeParametersType">
    <sequence>
      <element name="salt" type="string">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                            Salt used when hashing the value.
                        </summary>
            <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                            The value for this element is application dependent,
                            but to support consistency we suggest that the salt
                            be a base64 encoded series of bytes matching the
                            length requirement of the algorithm. For instance,
                            64 bytes for sha1 and sha256.
                        </remarks>
          </documentation>
        </annotation>
      </element>
      <element default="20000" name="iteration-count" type="int">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                        The number of iterations used when hashing the data.
                        </summary>
          </documentation>
        </annotation>
      </element>
      <element name="key-length" type="int">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">
                            The key length in bits used.
                        </summary>
            <remarks xmlns="http://www.w3.org/2001/XMLSchema">
                            The value depends on encryption algorithm.
                            The default is 168 for 3DES and 256 for aes256.
                        </remarks>
          </documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
  <complexType name="PackageEncryptionType">
    <sequence>
      <element name="algorithm-name">
        <simpleType>
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">Algorithm used for the encryption.</summary>
            </documentation>
          </annotation>
          <restriction base="string">
            <enumeration value="none">
              <annotation>
                <documentation>
                  <summary xmlns="http://www.w3.org/2001/XMLSchema">No encryption was used.</summary>
                </documentation>
              </annotation>
            </enumeration>
            <enumeration value="hmac-sha1-3des">
              <annotation>
                <documentation>
                  <summary xmlns="http://www.w3.org/2001/XMLSchema">Encrypted using the hmac-sha1 pseudorandom and the 
                                    3DES encryption function</summary>
                </documentation>
              </annotation>
            </enumeration>
            <enumeration value="hmac-sha256-aes256">
              <annotation>
                <documentation>
                  <summary xmlns="http://www.w3.org/2001/XMLSchema">
                                    Encrypted using the hmac-sha2 pseudorandom and the AES256 encryption function.
                                    </summary>
                </documentation>
              </annotation>
            </enumeration>
          </restriction>
        </simpleType>
      </element>
      <element minOccurs="0" maxOccurs="1" name="parameters" type="package:PbeParametersType">
        <annotation>
          <documentation>
            <summary xmlns="http://www.w3.org/2001/XMLSchema">Parameters used by the algorithm for the encryption.</summary>
          </documentation>
        </annotation>
      </element>
    </sequence>
  </complexType>
  <element name="password-protected-package">
    <annotation>
      <documentation>
        <summary xmlns="http://www.w3.org/2001/XMLSchema">
                Defines the schema for a package that can contain a password encrypted blob.
                </summary>
      </documentation>
    </annotation>
    <complexType>
      <sequence>
        <element name="encrypt-algorithm" type="package:PackageEncryptionType">
          <annotation>
            <documentation>
              <summary xmlns="http://www.w3.org/2001/XMLSchema">Algorithm used in the encryption</summary>
            </documentation>
          </annotation>
        </element>
      </sequence>
    </complexType>
  </element>
</schema>


Columns

Columns describe this type in the STT and MTT transformations.

Columns
TagLabelTypeWidth
algorithm-nameAlgorithm NameString100
wc-dateCreatedDateTime125
wc-noteDescriptionString100
wc-idIDString50
wc-versionVersion StampString50
wc-tagsTagsString100
wc-typeType NameString50
wc-typeidType IDString50
wc-sourceSourceString100
wc-brandsBrandsString100
wc-relatedthingsRelated ItemsString100
wc-ispersonalIs PersonalBoolean40
wc-audit-personnameChanged byString100
wc-audit-dateDateDateTime100
wc-audit-actionActionString100
wc-audit-appnameAppString100
wc-issignedSignedBoolean50
wc-isdownversionedDown VersionedBoolean50
wc-isupversionedUp VersionedBoolean50
wc-stateItem StateString50