PasswordProtectedPackage PasswordProtectedPackage 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
type PasswordProtectedPackage = class
    inherit HealthRecordItem
Public Class PasswordProtectedPackage
Inherits HealthRecordItem
Inheritance
PasswordProtectedPackagePasswordProtectedPackagePasswordProtectedPackage

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() PasswordProtectedPackage() PasswordProtectedPackage()

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

PasswordProtectedPackage(PasswordProtectAlgorithm, String, Int32) PasswordProtectedPackage(PasswordProtectAlgorithm, String, Int32) PasswordProtectedPackage(PasswordProtectAlgorithm, String, Int32)

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

Fields

TypeId TypeId TypeId

Retrieves the unique identifier for the item type.

Properties

CommonData CommonData CommonData

Gets the common data for the HealthRecordItem.

(Inherited from HealthRecordItem)
Created Created Created

Gets the audit information associated with the creation of this health record item.

(Inherited from HealthRecordItem)
EffectiveDate EffectiveDate EffectiveDate

Gets or sets the date and time that the health record item data was taken.

(Inherited from HealthRecordItem)
EffectivePermissions EffectivePermissions EffectivePermissions

Gets the effective permissions on the item granted to the person retrieving the HealthRecordItem.

(Inherited from HealthRecordItem)
Flags Flags Flags

Gets the HealthRecordItem flags.

(Inherited from HealthRecordItem)
HashIterations HashIterations HashIterations

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

HealthRecordItemSignatures HealthRecordItemSignatures HealthRecordItemSignatures

Gets the signatures for the HealthRecordItem.

(Inherited from HealthRecordItem)
IsDownVersioned IsDownVersioned IsDownVersioned

Gets the value indicating if the HealthRecordItem is down-versioned.

(Inherited from HealthRecordItem)
IsImmutable IsImmutable IsImmutable

Gets a value indicating whether the HealthRecordItem is immutable.

(Inherited from HealthRecordItem)
IsPersonal IsPersonal IsPersonal

Gets or sets the value indicating if the HealthRecordItem is private.

(Inherited from HealthRecordItem)
IsReadOnly IsReadOnly IsReadOnly

Gets a value indicating whether HealthRecordItem is read-only.

(Inherited from HealthRecordItem)
IsUpVersioned IsUpVersioned IsUpVersioned

Gets the value indicating if the HealthRecordItem is up-versioned.

(Inherited from HealthRecordItem)
Key Key Key

Gets the key of the health record item.

(Inherited from HealthRecordItem)
KeyLength KeyLength KeyLength

Gets or sets the key length in bits.

LastUpdated LastUpdated LastUpdated

Gets the audit information associated with the last update of this health record item.

(Inherited from HealthRecordItem)
PasswordProtectAlgorithm PasswordProtectAlgorithm PasswordProtectAlgorithm

Gets or sets the algorithm used to encrypt the package.

Salt Salt Salt

Gets or sets the salt used when encrypting the package.

Sections Sections Sections

Gets the data sections that this HealthRecordItem represents.

(Inherited from HealthRecordItem)
State State State

Gets the state of the HealthRecordItem.

(Inherited from HealthRecordItem)
Tags Tags Tags

Gets the list of tags on the HealthRecordItem.

(Inherited from HealthRecordItem)
TransformedXmlData TransformedXmlData TransformedXmlData

Gets the transformed XML data of the HealthRecordItem.

(Inherited from HealthRecordItem)
TypeName TypeName TypeName

Gets the health record item type name.

(Inherited from HealthRecordItem)
TypeSpecificData TypeSpecificData TypeSpecificData

Gets or sets the XML representation of the type-specific data for the HealthRecordItem.

(Inherited from HealthRecordItem)
UpdatedEndDate UpdatedEndDate UpdatedEndDate

Gets or sets the date when HealthRecordItem is not relevant.

(Inherited from HealthRecordItem)

Methods

GetBlobStore(ConnectPackageCreationParameters) GetBlobStore(ConnectPackageCreationParameters) GetBlobStore(ConnectPackageCreationParameters)

Gets the BLOB store for this health record item.

(Inherited from HealthRecordItem)
GetBlobStore(HealthRecordAccessor) GetBlobStore(HealthRecordAccessor) GetBlobStore(HealthRecordAccessor)

Gets the BLOB store for this health record item.

(Inherited from HealthRecordItem)
GetItemXml() GetItemXml() GetItemXml()

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetItemXml(HealthRecordItemSections) GetItemXml(HealthRecordItemSections) GetItemXml(HealthRecordItemSections)

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetItemXml(HealthRecordItemSections, String) GetItemXml(HealthRecordItemSections, String) GetItemXml(HealthRecordItemSections, String)

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetItemXml(String) GetItemXml(String) GetItemXml(String)

Gets the XML representation of the health record item.

(Inherited from HealthRecordItem)
GetSizeInBytes() GetSizeInBytes() GetSizeInBytes()

Gets the size of the health record item which will be added to the quota used in the person's health record.

(Inherited from HealthRecordItem)
IsSignatureValid() IsSignatureValid() IsSignatureValid()

Checks if the health record item's signature is valid.

(Inherited from HealthRecordItem)
ParseXml(IXPathNavigable) ParseXml(IXPathNavigable) ParseXml(IXPathNavigable)

Populates this PasswordProtectedPackage instance from the data in the XML.

Serialize() Serialize() Serialize()

Gets the XML representation of the item for serialization.

(Inherited from HealthRecordItem)
Sign(X509Certificate2) Sign(X509Certificate2) Sign(X509Certificate2)

Signs the HealthRecordItem with a digital signature.

(Inherited from HealthRecordItem)
ToString() ToString() ToString()

Gets a string representation of the password protected package definition.

ValidateCertificate() ValidateCertificate() ValidateCertificate()

Checks if the certificates are valid.

(Inherited from HealthRecordItem)
WriteXml(XmlWriter) WriteXml(XmlWriter) WriteXml(XmlWriter)

Writes the file data to the specified XmlWriter.

Applies to