EncryptedPackageEnvelope.IsEncryptedPackageEnvelope Method

Definition

Namespace:

System.IO.Packaging

Assembly:

WindowsBase.dll

Gets a value specifying whether the file is an OLE compound file with an encrypted package stream.

Overloads

IsEncryptedPackageEnvelope(Stream)	Gets a value specifying whether the specified stream is an OLE compound file with an encrypted package stream.
IsEncryptedPackageEnvelope(String)	Gets a value specifying whether the specified file is an OLE compound file with an encrypted package stream.

IsEncryptedPackageEnvelope(Stream)

Gets a value specifying whether the specified stream is an OLE compound file with an encrypted package stream.

public:
 static bool IsEncryptedPackageEnvelope(System::IO::Stream ^ stream);

public static bool IsEncryptedPackageEnvelope (System.IO.Stream stream);

static member IsEncryptedPackageEnvelope : System.IO.Stream -> bool

Public Shared Function IsEncryptedPackageEnvelope (stream As Stream) As Boolean

Parameters

stream

Stream

The stream that is tested.

Returns

Boolean

true if the specified stream is an OLE compound file with an encrypted package stream; otherwise, false.

Exceptions

ArgumentNullException

stream is null.

IsEncryptedPackageEnvelope(String)

Gets a value specifying whether the specified file is an OLE compound file with an encrypted package stream.

public:
 static bool IsEncryptedPackageEnvelope(System::String ^ fileName);

public static bool IsEncryptedPackageEnvelope (string fileName);

static member IsEncryptedPackageEnvelope : string -> bool

Public Shared Function IsEncryptedPackageEnvelope (fileName As String) As Boolean

Parameters

fileName

String

The file that is tested.

Returns

Boolean

true if the specified file is an OLE compound file with an encrypted package stream; otherwise, false.

Exceptions

ArgumentNullException

fileName is null.

Examples

The following example shows how to use this method to test for encryption.

WriteStatus("   Signing the UnsignedPublishLicense\n" +
            "       to build the PublishLicense.");
UseLicense authorsUseLicense;
PublishLicense publishLicense =
    unsignedLicense.Sign(_secureEnv, out authorsUseLicense);

WriteStatus("   Binding the author's UseLicense and");
WriteStatus("       obtaining the CryptoProvider.");
CryptoProvider cryptoProvider = authorsUseLicense.Bind(_secureEnv);

WriteStatus("   Creating the EncryptedPackage.");
Stream packageStream = File.OpenRead(packageFile);
EncryptedPackageEnvelope ePackage =
    EncryptedPackageEnvelope.CreateFromPackage(encryptedFile,
        packageStream, publishLicense, cryptoProvider);

WriteStatus("   Adding an author's UseLicense.");
RightsManagementInformation rmi =
    ePackage.RightsManagementInformation;
rmi.SaveUseLicense(author, authorsUseLicense);

ePackage.Close();
WriteStatus("   Done - Package encryption complete.");

WriteStatus("Verifying package encryption.");
if (EncryptedPackageEnvelope.IsEncryptedPackageEnvelope(encryptedFile))
{
    WriteStatus("   Confirmed - '" + encryptedFilename +
                "' is encrypted.");
}
else
{
    MessageBox.Show("ERROR: '" + encryptedFilename +
        "' is NOT ENCRYPTED.", "Encryption Error",
        MessageBoxButton.OK, MessageBoxImage.Error);
    WriteStatus("ERROR: '" + encryptedFilename +
                "' is NOT ENCRYPTED.\n");
    return false;
}

WriteStatus("   Signing the UnsignedPublishLicense" & vbLf & "       to build the PublishLicense.")
Dim authorsUseLicense As UseLicense = Nothing
Dim publishLicense As PublishLicense = unsignedLicense.Sign(_secureEnv, authorsUseLicense)

WriteStatus("   Binding the author's UseLicense and")
WriteStatus("       obtaining the CryptoProvider.")
Dim cryptoProvider As CryptoProvider = authorsUseLicense.Bind(_secureEnv)

WriteStatus("   Creating the EncryptedPackage.")
Dim packageStream As Stream = File.OpenRead(packageFile)
Dim ePackage As EncryptedPackageEnvelope = EncryptedPackageEnvelope.CreateFromPackage(encryptedFile, packageStream, publishLicense, cryptoProvider)

WriteStatus("   Adding an author's UseLicense.")
Dim rmi As RightsManagementInformation = ePackage.RightsManagementInformation
rmi.SaveUseLicense(author, authorsUseLicense)

ePackage.Close()
WriteStatus("   Done - Package encryption complete.")

WriteStatus("Verifying package encryption.")
If EncryptedPackageEnvelope.IsEncryptedPackageEnvelope(encryptedFile) Then
    WriteStatus("   Confirmed - '" & encryptedFilename & "' is encrypted.")
Else
    MessageBox.Show("ERROR: '" & encryptedFilename & "' is NOT ENCRYPTED.", "Encryption Error", MessageBoxButton.OK, MessageBoxImage.Error)
    WriteStatus("ERROR: '" & encryptedFilename & "' is NOT ENCRYPTED." & vbLf)
    Return False
End If