PasswordProtectedPackage Class

Definition

Provides metadata about the encryption algorithm and parameters used to protect some data with a password.

public class PasswordProtectedPackage : Microsoft.Health.HealthRecordItem
Inheritance
PasswordProtectedPackage

Inherited Members

Microsoft.Health.HealthRecordItem

Remarks

The PasswordProtectedPackage item type defines the metadata for the encryption algorithm used to protect data with a password. The application should generate a password (or take it from the user) and encrypt the desired data. This data should be set in a Blob created off the BlobStore retrieved from the GetBlobStore(HealthRecordAccessor). The properties of the Blob should be set with the parameters required to decrypt the data. These parameters are application dependant but should adhere to standard practices in dealing with PKCS5v2 data.

Constructors

PasswordProtectedPackage()

Creates a new instance of the PasswordProtectedPackage class with default values.

PasswordProtectedPackage(PasswordProtectAlgorithm, String, Int32)

Creates a new instance of the PasswordProtectedPackage class specifying the mandatory values.

Fields

TypeId

Retrieves the unique identifier for the item type.

Properties

HashIterations

Gets or sets the number of hash iterations taken when protecting the package.

KeyLength

Gets or sets the key length in bits.

PasswordProtectAlgorithm

Gets or sets the algorithm used to encrypt the package.

Salt

Gets or sets the salt used when encrypting the package.

Methods

ParseXml(IXPathNavigable)

Populates this PasswordProtectedPackage instance from the data in the XML.

ToString()

Gets a string representation of the password protected package definition.

WriteXml(XmlWriter)

Writes the file data to the specified XmlWriter.