Unprotect Method

Unprotects the data.

Syntax

ANSI (Cross Platform)
int Unprotect();

Unicode (Windows)
INT Unprotect();

- (void)unprotect;

#define MID_DPAPI_UNPROTECT 7

IPWORKSENCRYPT_EXTERNAL int IPWORKSENCRYPT_CALL IPWorksEncrypt_DPAPI_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

Unprotect unprotects the specified data.

The class supports unprotecting data using either the classic DPAPI or CNG DPAPI implementation. The use of UseCNG determines which implementation is used. The list of applicable properties differs depending on whether CNG DPAPI is being used.

When using classic DPAPI (UseCNG is False), the following optional properties are applicable:

DataDescription (populated after completion)
Password

When using CNG DPAPI (UseCNG is True), the following properties are applicable:

ProtectionDescriptor (populated after completion)
UseStreamMode

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

SetOutputStream
OutputFile
OutputMessage: The output data is written to this property if no other destination is specified.

When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing.

Code Example (Classic DPAPI - UseCNG is False)

//Protect
Dpapi dpapi = new Dpapi();
dpapi.InputMessage = "test";
dpapi.Protect();
byte[] protectedData = dpapi.OutputMessageB;
 
//Unprotect
dpapi = new Dpapi();
dpapi.InputMessageB = protectedData;
dpapi.Unprotect();
Console.WriteLine(dpapi.OutputMessage); //outputs "test"

Code Example (CNG DPAPI - UseCNG is True)

//Protect
Dpapi dpapi = new Dpapi();
dpapi.UseCNG = true;
dpapi.ProtectionDescriptor = "LOCAL=user";
dpapi.InputMessage = "test";
dpapi.Protect();
byte[] protectedData = dpapi.OutputMessageB;
 
//Unprotect
dpapi = new Dpapi();
dpapi.UseCNG = true;
dpapi.InputMessageB = protectedData;
dpapi.Unprotect();
Console.WriteLine(dpapi.OutputMessage); //outputs "test"

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

IPWorks Encrypt 2020 C++ Edition Website Download Support Questions / Feedback?
IPWorks Encrypt 2020 C++ Edition Introduction Licensing Instructions AES Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes Blowfish Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes CAST Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes CertMgr Class Introduction Properties CertEffectiveDate CertEncoded CertExpirationDate CertExtendedKeyUsage CertFingerprint CertIssuer CertKeyPassword CertPrivateKey CertPrivateKeyAvailable CertPrivateKeyContainer CertPublicKey CertPublicKeyAlgorithm CertPublicKeyLength CertSerialNumber CertSignatureAlgorithm CertSubject CertSubjectAltNames CertThumbprintMD5 CertThumbprintSHA1 CertThumbprintSHA256 CertUsage CertUsageFlags CertVersion CertExtensionCount CertExtensionCritical CertExtensionOID CertExtensionValue CertStore CertStorePassword CertStoreType ExportedCert ExportFormat ExportPrivateKey Methods Config CreateCertificate CreateKey DeleteCertificate DeleteKey ExportCertificate GenerateCSR ImportCertificate ImportSignedCSR IssueCertificate ListCertificateStores ListKeys ListMachineStores ListStoreCertificates ReadCertificate ReadCSR Reset SaveCertificate ShowCertificateChain SignCSR Events CertChain CertList Error KeyList Log StoreList Configuration Error Codes ChaCha Class Introduction Properties AdditionalAuthData AuthTag InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite UseAEAD UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes CMS Class Introduction Properties CertCount CertEncoded CertStore CertStorePassword CertStoreType CertSubject DetachedSignature DetachedSignatureData EnableCompression EncryptionAlgorithm IncludeCertificates InputFile InputMessage OutputFile OutputFormat OutputMessage RecipientCertCount RecipientCertEncoded RecipientCertStore RecipientCertStorePassword RecipientCertStoreType RecipientCertSubject SignatureHashAlgorithm SignerCertCount SignerCertEncoded SignerCertStore SignerCertStorePassword SignerCertStoreType SignerCertSubject UseOAEP UsePSS Methods AddCertificate AddRecipientCert Config Decrypt DecryptAndVerifySignature Encrypt GetRecipientInfo GetSignerCertInfo Reset SetInputStream SetOutputStream Sign SignAndEncrypt VerifySignature Events Error Log RecipientInfo SignerCertInfo Types IPWorksEncryptStream Configuration Error Codes DES Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes DPAPI Class Introduction Properties DataDescription InputFile InputMessage OutputFile OutputMessage Overwrite Password PromptTitle PromptUser ProtectionDescriptor UseCNG UseHex Methods Config Protect Reset SetInputStream SetOutputStream Unprotect Events Error Progress Types IPWorksEncryptStream Configuration Error Codes DSA Class Introduction Properties CertEncoded CertStore CertStorePassword CertStoreType CertSubject HashAlgorithm HashSignature HashValue InputFile InputMessage KeyG KeyP KeyPrivateKey KeyPublicKey KeyQ KeyX KeyY SignerCertEncoded SignerCertStore SignerCertStorePassword SignerCertStoreType SignerCertSubject SignerKeyG SignerKeyP SignerKeyPublicKey SignerKeyQ SignerKeyY UseHex Methods Config CreateKey Reset SetInputStream Sign VerifySignature Events Error Progress Types IPWorksEncryptStream Configuration Error Codes ECC Class Introduction Properties ComputeSecretKDF EncryptionAlgorithm HashAlgorithm HashEdDSA HashSignature HashValue HMACAlgorithm InputFile InputMessage IV KDF KDFHashAlgorithm KeyAlgorithm KeyK KeyPrivateKey KeyPublicKey KeyRx KeyRy KeyXPk KeyXSk OutputFile OutputMessage Overwrite RecipientKeyAlgorithm RecipientKeyPublicKey RecipientKeyRx RecipientKeyRy RecipientKeyXPk SharedSecret SignerKeyAlgorithm SignerKeyPublicKey SignerKeyRx SignerKeyRy SignerKeyXPk UseHex Methods ComputeSecret Config CreateKey Decrypt Encrypt Reset SetInputStream SetOutputStream Sign VerifySignature Events Error Progress Types IPWorksEncryptStream Configuration Error Codes Elgamal Class Introduction Properties InputFile InputMessage KeyG KeyP KeyPrivateKey KeyPublicKey KeyX KeyY OutputFile OutputMessage Overwrite RecipientKeyG RecipientKeyP RecipientKeyPublicKey RecipientKeyY UseHex Methods Config CreateKey Decrypt Encrypt Reset SetInputStream Events Error Types IPWorksEncryptStream Configuration Error Codes EzCrypt Class Introduction Properties Algorithm CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes EzRand Class Introduction Properties Algorithm Max Min RandBytes RandBytesLength RandInt Seed Methods Config GetNextBytes GetNextInt Reset Events Error Configuration Error Codes Hash Class Introduction Properties Algorithm EncodeHash HashValue InputFile InputMessage Key Methods ComputeHash Config HashBlock Reset SetInputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes IDEA Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes JWE Class Introduction Properties CertEncoded CertStore CertStorePassword CertStoreType CertSubject ContentEncryptionAlgorithm EncryptionAlgorithm HeaderParamCount HeaderParamDataType HeaderParamName HeaderParamValue InputFile InputMessage Key KeyId KeyPassword OutputFile OutputMessage Overwrite Methods AddHeaderParam Config Decrypt Encrypt Parse Reset SetInputStream SetOutputStream Events Error HeaderParam RecipientInfo Types IPWorksEncryptStream Configuration Error Codes JWS Class Introduction Properties Algorithm CertEncoded CertStore CertStorePassword CertStoreType CertSubject HeaderParamCount HeaderParamDataType HeaderParamName HeaderParamValue InputFile InputMessage Key KeyId OutputFile OutputMessage Overwrite Methods AddHeaderParam Config Parse Reset SetInputStream SetOutputStream Sign Verify Events Error HeaderParam SignerInfo Types IPWorksEncryptStream Configuration Error Codes KeyMgr Class Introduction Properties KeyCurve KeyEffectiveDate KeyEncoded KeyExpirationDate KeyFingerprint KeyId KeyOtherUserIds KeyPassphrase KeyPublicKey KeyPublicKeyAlgorithm KeyPublicKeyLength KeyRevoked KeySecretKey KeySecretKeyAvailable KeyUsage KeyUsageFlags KeyUserId Keyring Methods AddRevoker AddUserId ChangeExpirationDate ChangePassphrase Config CreateKey CreateSubKey DeleteKey ExportPublicKey ExportSecretKey ImportKey ImportKeyB ListKeys ListSignatures ListSubkeys LoadKeyring Reset RevokeKey SaveKeyring SignUserId VerifyPassphrase Events Error KeyList KeyPassphrase SignatureList Status SubkeyList Configuration Error Codes OpenPGP Class Introduction Properties ASCIIArmor AutoSelectAlgorithms ClearSignature CompressionMethod DetachedSignature EncryptingAlgorithm InputFile InputMessage KeyCount KeyEncoded KeyKeyring KeyPassphrase KeyUserId MessageHeaderCount MessageHeaderField MessageHeaderValue OutputFile OutputMessage Overwrite RecipientKeyCount RecipientKeyEncoded RecipientKeyKeyring RecipientKeyUserId SignerKeyCount SignerKeyEncoded SignerKeyKeyring SignerKeyUserId SigningAlgorithm Methods Config Decrypt DecryptAndVerifySignature Encrypt GetRecipientInfo Reset SetInputStream SetOutputStream Sign SignAndEncrypt VerifySignature Events Error KeyPassphrase Progress RecipientInfo SignatureInfo Status VerificationStatus Types IPWorksEncryptStream Configuration Error Codes PBKDF Class Introduction Properties Algorithm Iterations Key KeyLength Password Salt UseHex Version Methods Config CreateKey Reset Events Error Configuration Error Codes Poly1305 Class Introduction Properties EncodeMAC InputFile InputMessage Key MACValue Methods ComputeMAC ComputeMACBlock Config Reset SetInputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes RC2 Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes RC4 Class Introduction Properties InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes Rijndael Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes RSA Class Introduction Properties CertEncoded CertStore CertStorePassword CertStoreType CertSubject HashAlgorithm HashSignature HashValue InputFile InputMessage KeyD KeyDP KeyDQ KeyExponent KeyInverseQ KeyModulus KeyP KeyPrivateKey KeyPublicKey KeyQ OutputFile OutputMessage Overwrite RecipientCertEncoded RecipientCertStore RecipientCertStorePassword RecipientCertStoreType RecipientCertSubject RecipientKeyExponent RecipientKeyModulus RecipientKeyPublicKey SignerCertEncoded SignerCertStore SignerCertStorePassword SignerCertStoreType SignerCertSubject SignerKeyExponent SignerKeyModulus SignerKeyPublicKey UseHex UseOAEP UsePSS Methods Config CreateKey Decrypt Encrypt Reset SetInputStream SetOutputStream Sign VerifySignature Events Error Progress Types IPWorksEncryptStream Configuration Error Codes Salsa20 Class Introduction Properties Algorithm InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes SMIME Class Introduction Properties CertEncoded CertStore CertStorePassword CertStoreType CertSubject DetachedSignature EncryptingAlgorithm IncludeCertificate IncludeChain IncludeHeaders InputFile InputMessage InputMessageHeaderCount InputMessageHeaderField InputMessageHeaderValue InputMessageHeadersString InternalHeaders MessageEncrypted MessageSigned OutputFile OutputMessage OutputMessageHeaderCount OutputMessageHeaderField OutputMessageHeaderValue OutputMessageHeadersString Overwrite RecipientCertCount RecipientCertEncoded RecipientCertStore RecipientCertStorePassword RecipientCertStoreType RecipientCertSubject SignerCertEncoded SignerCertIssuer SignerCertSerialNumber SignerCertStore SignerCertStorePassword SignerCertStoreType SignerCertSubject SignerCertChainCount SignerCertChainEncoded SigningAlgorithm UseOAEP UsePSS Methods AddRecipientCert Config Decrypt DecryptAndVerifySignature Encrypt GetRecipientInfo GetSignerCertInfo Reset Sign SignAndEncrypt VerifySignature Events Error RecipientInfo SignerCertInfo Configuration Error Codes TEA Class Introduction Properties Algorithm CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes TripleDES Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes Twofish Class Introduction Properties CipherMode InputFile InputMessage IV Key KeyPassword OutputFile OutputMessage Overwrite PaddingMode UseHex Methods Config Decrypt DecryptBlock Encrypt EncryptBlock Reset SetInputStream SetOutputStream Events Error Progress Types IPWorksEncryptStream Configuration Error Codes XMLEncrypt Class Introduction Properties CertEncoded CertStore CertStorePassword CertStoreType CertSubject EncryptedDataDetailCount EncryptedDataDetailId EncryptedDataDetailMIMEType EncryptedDataDetailScope EncryptedDataDetailXMLElement EncryptingAlgorithm InputFile InputXML OutputFile OutputXML Overwrite RecipientCertEncoded RecipientCertStore RecipientCertStorePassword RecipientCertStoreType RecipientCertSubject SymmetricKey UseOAEP Methods Config Decrypt DoEvents Encrypt Reset SetInputStream SetOutputStream Events EncryptedDataInfo Error Progress Status Types IPWorksEncryptStream Configuration Error Codes XMLSig Class Introduction Properties CanonicalizationMethod CertEncoded CertStore CertStorePassword CertStoreType CertSubject HMACKey InputFile InputXML OutputFile OutputXML Overwrite ReferenceCount ReferenceHashAlgorithm ReferenceHashValue ReferenceTransformAlgorithms ReferenceURI ReferenceXMLElement SignatureXPath SignerCertEncoded SignerCertStore SignerCertStorePassword SignerCertStoreType SignerCertSubject SigningAlgorithm Methods Config DoEvents Reset SetInputStream SetOutputStream Sign VerifySignature Events Error Progress SignatureInfo Status Types IPWorksEncryptStream Configuration Error Codes Software License	Unprotect Method Unprotects the data. Syntax C++ Objective-C C ANSI (Cross Platform) int Unprotect(); Unicode (Windows) INT Unprotect(); - (void)unprotect; #define MID_DPAPI_UNPROTECT 7 IPWORKSENCRYPT_EXTERNAL int IPWORKSENCRYPT_CALL IPWorksEncrypt_DPAPI_Do(void lpObj, int methid, int cparam, void param[], int cbparam[], int64 lpllVal); Remarks Unprotect unprotects the specified data. The class supports unprotecting data using either the classic DPAPI or CNG DPAPI implementation. The use of UseCNG determines which implementation is used. The list of applicable properties differs depending on whether CNG DPAPI is being used. When using classic DPAPI (UseCNG is `False`), the following optional properties are applicable: DataDescription (populated after completion) Password When using CNG DPAPI (UseCNG is `True`), the following properties are applicable: ProtectionDescriptor (populated after completion) UseStreamMode Input and Output Properties* The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: SetInputStream InputFile InputMessage When a valid source is found the search stops. The order in which the output properties are checked is as follows: SetOutputStream OutputFile OutputMessage: The output data is written to this property if no other destination is specified. When using streams you may need to additionally set CloseInputStreamAfterProcessing or CloseOutputStreamAfterProcessing. Code Example (Classic DPAPI - UseCNG is False) view source `//Protect` `Dpapi dpapi =` `new` `Dpapi();` `dpapi.InputMessage =` `"test";` `dpapi.Protect();` `byte[] protectedData = dpapi.OutputMessageB;` `//Unprotect` `dpapi =` `new` `Dpapi();` `dpapi.InputMessageB = protectedData;` `dpapi.Unprotect();` `Console.WriteLine(dpapi.OutputMessage);` `//outputs "test"` Code Example (CNG DPAPI - UseCNG is True) view source `//Protect` `Dpapi dpapi =` `new` `Dpapi();` `dpapi.UseCNG =` `true;` `dpapi.ProtectionDescriptor =` `"LOCAL=user";` `dpapi.InputMessage =` `"test";` `dpapi.Protect();` `byte[] protectedData = dpapi.OutputMessageB;` `//Unprotect` `dpapi =` `new` `Dpapi();` `dpapi.UseCNG =` `true;` `dpapi.InputMessageB = protectedData;` `dpapi.Unprotect();` `Console.WriteLine(dpapi.OutputMessage);` `//outputs "test"` Error Handling (C++) This method returns a result code; `0` indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the `GetLastError()` method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the `GetLastErrorCode()` method after it returns.)
Copyright (c) 2022 /n software inc. - All rights reserved. IPWorks Encrypt 2020 C++ Edition - Version 20.0 [Build 8155]

IPWorks Encrypt 2020 C++ Edition

Unprotect Method

Syntax

Remarks

Error Handling (C++)

Questions / Feedback?