From 5dbe1dc280098d80591c6dbce547761a1b54c0c5 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Fri, 28 Mar 2025 14:15:51 -0700 Subject: [PATCH] fix mismatched paramrefs --- .../CompoundAce.xml | 2 +- .../CustomAce.xml | 22 +- .../FileSecurity.xml | 2 +- .../GenericAce.xml | 22 +- .../GenericAcl.xml | 12 +- .../GenericSecurityDescriptor.xml | 2 +- .../ObjectAce.xml | 22 +- .../ObjectAuditRule.xml | 2 +- xml/System.Security.AccessControl/RawAcl.xml | 24 +- .../RegistryAccessRule.xml | 4 +- .../ServiceNameCollection.xml | 52 +- .../CoseHeaderMap.xml | 2 +- .../CmsRecipient.xml | 50 +- .../ContentInfo.xml | 56 +- .../Pkcs12KeyBag.xml | 16 +- .../Pkcs12ShroudedKeyBag.xml | 16 +- .../Pkcs9AttributeObject.xml | 20 +- .../CertificateRequest.xml | 12 +- .../X509Certificate.xml | 8 +- .../X509CertificateCollection.xml | 36 +- .../CipherData.xml | 202 ++- .../EncryptedXml.xml | 1156 ++++++++-------- .../CryptoStream.xml | 2 +- ...CryptographicAttributeObjectCollection.xml | 32 +- .../DSACryptoServiceProvider.xml | 2 +- .../DpapiDataProtector.xml | 66 +- xml/System.Security.Cryptography/RC2.xml | 96 +- xml/System.Security.Cryptography/RSA.xml | 1178 ++++++++--------- .../RSAOpenSsl.xml | 2 +- .../Rfc2898DeriveBytes.xml | 2 - .../FileDialogPermission.xml | 80 +- .../ApplicationTrustCollection.xml | 208 +-- .../CryptoProvider.xml | 2 +- 33 files changed, 1698 insertions(+), 1712 deletions(-) diff --git a/xml/System.Security.AccessControl/CompoundAce.xml b/xml/System.Security.AccessControl/CompoundAce.xml index 93d05ddccd1..435a210ef0f 100644 --- a/xml/System.Security.AccessControl/CompoundAce.xml +++ b/xml/System.Security.AccessControl/CompoundAce.xml @@ -183,7 +183,7 @@ Marshals the contents of the object into the specified byte array beginning at the specified offset. To be added. - is negative or too high to allow the entire to be copied into . + is negative or too high to allow the entire to be copied into . diff --git a/xml/System.Security.AccessControl/CustomAce.xml b/xml/System.Security.AccessControl/CustomAce.xml index f73ca205c31..2d512e5042b 100644 --- a/xml/System.Security.AccessControl/CustomAce.xml +++ b/xml/System.Security.AccessControl/CustomAce.xml @@ -35,11 +35,11 @@ Represents an Access Control Entry (ACE) that is not defined by one of the members of the enumeration. - object contains an ACE header and an opaque blob of data. - + object contains an ACE header and an opaque blob of data. + ]]> @@ -81,11 +81,11 @@ An array of byte values that contains the data for the new ACE. This value can be . The length of this array must not be greater than the value of the field, and must be a multiple of four. Initializes a new instance of the class. - The value of the parameter is not greater than or the length of the array is either greater than the value of the field or not a multiple of four. @@ -163,7 +163,7 @@ Marshals the contents of the object into the specified byte array beginning at the specified offset. To be added. - is negative or too high to allow the entire to be copied into . + is negative or too high to allow the entire to be copied into . diff --git a/xml/System.Security.AccessControl/FileSecurity.xml b/xml/System.Security.AccessControl/FileSecurity.xml index fb06daef867..543cf4234ce 100644 --- a/xml/System.Security.AccessControl/FileSecurity.xml +++ b/xml/System.Security.AccessControl/FileSecurity.xml @@ -180,7 +180,7 @@ You can add access or audit rules to the The file specified in the parameter was not found. An I/O error occurred while opening the file. - is in an invalid format. + is in an invalid format. The parameter is . The current operating system is not Microsoft Windows 2000 or later. The specified path, file name, or both exceed the system-defined maximum length. diff --git a/xml/System.Security.AccessControl/GenericAce.xml b/xml/System.Security.AccessControl/GenericAce.xml index 1cad8198a34..f17e7fab186 100644 --- a/xml/System.Security.AccessControl/GenericAce.xml +++ b/xml/System.Security.AccessControl/GenericAce.xml @@ -35,11 +35,11 @@ Represents an Access Control Entry (ACE), and is the base class for all other ACE classes. - @@ -76,11 +76,11 @@ Gets or sets the associated with this object. The associated with this object. - object contains flags that specify information about the inheritance, inheritance propagation, and auditing conditions for an Access Control Entry (ACE). - + object contains flags that specify information about the inheritance, inheritance propagation, and auditing conditions for an Access Control Entry (ACE). + ]]> @@ -347,7 +347,7 @@ Marshals the contents of the object into the specified byte array beginning at the specified offset. To be added. - is negative or too high to allow the entire to be copied into . + is negative or too high to allow the entire to be copied into . diff --git a/xml/System.Security.AccessControl/GenericAcl.xml b/xml/System.Security.AccessControl/GenericAcl.xml index cda7af96678..25488141107 100644 --- a/xml/System.Security.AccessControl/GenericAcl.xml +++ b/xml/System.Security.AccessControl/GenericAcl.xml @@ -105,11 +105,11 @@ The revision level of the current . This value is returned by the property for Access Control Lists (ACLs) that are not associated with Directory Services objects. - class has been created. - + class has been created. + ]]> @@ -295,7 +295,7 @@ Marshals the contents of the object into the specified byte array beginning at the specified offset. To be added. - is negative or too high to allow the entire to be copied into . + is negative or too high to allow the entire to be copied into . diff --git a/xml/System.Security.AccessControl/GenericSecurityDescriptor.xml b/xml/System.Security.AccessControl/GenericSecurityDescriptor.xml index e9b587f1275..235fd3f9321 100644 --- a/xml/System.Security.AccessControl/GenericSecurityDescriptor.xml +++ b/xml/System.Security.AccessControl/GenericSecurityDescriptor.xml @@ -167,7 +167,7 @@ Returns an array of byte values that represents the information contained in this object. To be added. - is negative or too high to allow the entire to be copied into . + is negative or too high to allow the entire to be copied into . diff --git a/xml/System.Security.AccessControl/ObjectAce.xml b/xml/System.Security.AccessControl/ObjectAce.xml index d30d12ac705..fd594e09759 100644 --- a/xml/System.Security.AccessControl/ObjectAce.xml +++ b/xml/System.Security.AccessControl/ObjectAce.xml @@ -169,7 +169,7 @@ Marshals the contents of the object into the specified byte array beginning at the specified offset. To be added. - is negative or too high to allow the entire to be copied into . + is negative or too high to allow the entire to be copied into . @@ -204,11 +204,11 @@ Gets or sets the GUID of the object type that can inherit the Access Control Entry (ACE) that this object represents. The GUID of the object type that can inherit the Access Control Entry (ACE) that this object represents. - parameter does not contain the value , this property is ignored. - + parameter does not contain the value , this property is ignored. + ]]> @@ -317,11 +317,11 @@ Gets or sets the GUID of the object type associated with this object. The GUID of the object type associated with this object. - parameter does not contain the value , this property is ignored. - + parameter does not contain the value , this property is ignored. + ]]> diff --git a/xml/System.Security.AccessControl/ObjectAuditRule.xml b/xml/System.Security.AccessControl/ObjectAuditRule.xml index 86b262e151e..1687baf3d23 100644 --- a/xml/System.Security.AccessControl/ObjectAuditRule.xml +++ b/xml/System.Security.AccessControl/ObjectAuditRule.xml @@ -78,7 +78,7 @@ The audit conditions. Initializes a new instance of the class. To be added. - The value of the parameter cannot be cast as a , or the parameter contains an invalid value. + The value of the parameter cannot be cast as a , or the parameter contains an invalid value. The value of the parameter is 0, or the or parameters contain unrecognized flag values. diff --git a/xml/System.Security.AccessControl/RawAcl.xml b/xml/System.Security.AccessControl/RawAcl.xml index d87bd754154..8f910f34311 100644 --- a/xml/System.Security.AccessControl/RawAcl.xml +++ b/xml/System.Security.AccessControl/RawAcl.xml @@ -35,11 +35,11 @@ Represents an Access Control List (ACL). - class allows full manipulation of Access Control Entries (ACEs). It does not enforce ordering rules for ACEs and does not provide validation logic. Any ACE can be inserted, modified, or removed at any location in the ACL. - + class allows full manipulation of Access Control Entries (ACEs). It does not enforce ordering rules for ACEs and does not provide validation logic. Any ACE can be inserted, modified, or removed at any location in the ACL. + ]]> @@ -231,7 +231,7 @@ Marshals the contents of the object into the specified byte array beginning at the specified offset. To be added. - is negative or too high to allow the entire to be copied into . + is negative or too high to allow the entire to be copied into . @@ -271,15 +271,13 @@ The ACE to insert. Inserts the specified Access Control Entry (ACE) at the specified index. - - - is negative or too high to allow the entire to be copied into . diff --git a/xml/System.Security.AccessControl/RegistryAccessRule.xml b/xml/System.Security.AccessControl/RegistryAccessRule.xml index f0f1727e231..525ec76e2b5 100644 --- a/xml/System.Security.AccessControl/RegistryAccessRule.xml +++ b/xml/System.Security.AccessControl/RegistryAccessRule.xml @@ -163,7 +163,7 @@ -or- - is zero. + is zero. is neither of type nor of a type such as that can be converted to type . @@ -426,7 +426,7 @@ specifies an invalid value. - is zero. + is zero. is . diff --git a/xml/System.Security.Authentication.ExtendedProtection/ServiceNameCollection.xml b/xml/System.Security.Authentication.ExtendedProtection/ServiceNameCollection.xml index 6cf29ad75df..b5da82918b2 100644 --- a/xml/System.Security.Authentication.ExtendedProtection/ServiceNameCollection.xml +++ b/xml/System.Security.Authentication.ExtendedProtection/ServiceNameCollection.xml @@ -68,11 +68,11 @@ The class is a read-only collection of service principal names. - class is used in an when validating against a custom list of service provider names (SPNs). - + class is used in an when validating against a custom list of service provider names (SPNs). + ]]> @@ -116,17 +116,17 @@ An instance of the class that contains the specified values of service names to be used to initialize the class. Initializes a new read-only instance of the class based on an existing . - class that is initialized contains the specified values passed in the `items` parameter. - + class that is initialized contains the specified values passed in the `items` parameter. + ]]> - is . + is . - is empty. + is empty. @@ -170,8 +170,8 @@ The string to seek. Returns a value indicating whether the specified string occurs within this instance. - Returns . - + Returns . + if the parameter occurs within this instance; otherwise, . To be added. @@ -290,11 +290,11 @@ Merges the current with the specified values to create a new containing the union. A new instance that contains the union of the existing instance merged with the specified values. - class that is initialized contains the specified values passed in the `items` parameter. - + class that is initialized contains the specified values passed in the `items` parameter. + ]]> @@ -346,17 +346,17 @@ Merges the current with the specified values to create a new containing the union. A new instance that contains the union of the existing instance merged with the specified values. - class that is initialized contains the specified values passed in the `items` parameter. - + class that is initialized contains the specified values passed in the `items` parameter. + ]]> - is . + is . - is empty. + is empty. diff --git a/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml b/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml index 9725dd60ed6..2a457cb4b9b 100644 --- a/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml +++ b/xml/System.Security.Cryptography.Cose/CoseHeaderMap.xml @@ -678,7 +678,7 @@ The label of the element to remove. Removes the element with the specified key from the . - if the element is successfully removed; otherwise, . This method also returns if was not found in the original . + if the element is successfully removed; otherwise, . This method also returns if was not found in the original . To be added. The header map is read-only. diff --git a/xml/System.Security.Cryptography.Pkcs/CmsRecipient.xml b/xml/System.Security.Cryptography.Pkcs/CmsRecipient.xml index 332a5ae5c2d..2b039b07873 100644 --- a/xml/System.Security.Cryptography.Pkcs/CmsRecipient.xml +++ b/xml/System.Security.Cryptography.Pkcs/CmsRecipient.xml @@ -85,16 +85,16 @@ The certificate to use when encrypting for this recipient. Initializes a new instance of the class with a specified certificate, using the default encryption mode for the public key algorithm and an subject identifier. - class has the following default property values. - -|Property|Default value| -|--------------|-------------------| -||| -||null| - + class has the following default property values. + +|Property|Default value| +|--------------|-------------------| +||| +||null| + ]]> The parameter is . @@ -174,23 +174,19 @@ The RSA padding mode to use when encrypting for this recipient. Initializes a new instance of the class with a specified RSA certificate and RSA encryption padding, using an subject identifier. - class has the following default property values. - -|Property|Default value| -|--------------|-------------------| -||| - + class has the following default property values. + +|Property|Default value| +|--------------|-------------------| +||| + ]]> The or parameter is . - The parameter public key is not recognized as an RSA public key. - --or- - -The value is not supported. + The parameter public key is not recognized as an RSA public key. @@ -337,9 +333,9 @@ The value is not supported.Gets the RSA encryption padding to use when encrypting for this recipient. The RSA encryption padding to use when encrypting for this recipient. - diff --git a/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml b/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml index e98fb86ab92..80850106094 100644 --- a/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml +++ b/xml/System.Security.Cryptography.Pkcs/ContentInfo.xml @@ -83,17 +83,17 @@ An array of byte values that represents the data from which to create the object. - The constructor creates an instance of the class by using an array of byte values as the data and a default (OID) that represents the content type. + The constructor creates an instance of the class by using an array of byte values as the data and a default object identifier (OID) that represents the content type. - class has the following default property values. - -|Property|Default value| -|--------------|-------------------| -||1.2.840.113549.1.7.1 (data)| - + class has the following default property values. + +|Property|Default value| +|--------------|-------------------| +||1.2.840.113549.1.7.1 (data)| + ]]> A null reference was passed to a method that does not accept it as a valid argument. @@ -134,23 +134,23 @@ An array of byte values that represents the data from which to create the object. The constructor creates an instance of the class by using the specified content type and an array of byte values as the data. - constructor to build the `contentType` content type parameter. - -|`contentType` content type|OID string| -|--------------------------------|----------------| -|data|1.2.840.113549.1.7.1| -|digestedData|1.2.840.113549.1.7.5| -|encryptedData|1.2.840.113549.1.7.6| -|envelopedData|1.2.840.113549.1.7.3| -|hashedData|1.2.840.113549.1.7.5| -|signedAndEnvelopedData|1.2.840.113549.1.7.4| -|signedData|1.2.840.113549.1.7.2| - + constructor to build the `contentType` content type parameter. + +|`contentType` content type|OID string| +|--------------------------------|----------------| +|data|1.2.840.113549.1.7.1| +|digestedData|1.2.840.113549.1.7.5| +|encryptedData|1.2.840.113549.1.7.6| +|envelopedData|1.2.840.113549.1.7.3| +|hashedData|1.2.840.113549.1.7.5| +|signedAndEnvelopedData|1.2.840.113549.1.7.4| +|signedData|1.2.840.113549.1.7.2| + ]]> A null reference was passed to a method that does not accept it as a valid argument. @@ -222,7 +222,7 @@ System.Security.Cryptography.Oid - The property retrieves the object that contains the (OID) of the content type of the inner content of the CMS/PKCS #7 message. + The property retrieves the object that contains the object identifier (OID) of the content type of the inner content of the CMS/PKCS #7 message. An object that contains the OID value that represents the content type. To be added. diff --git a/xml/System.Security.Cryptography.Pkcs/Pkcs12KeyBag.xml b/xml/System.Security.Cryptography.Pkcs/Pkcs12KeyBag.xml index ea212839495..a3e420d2303 100644 --- a/xml/System.Security.Cryptography.Pkcs/Pkcs12KeyBag.xml +++ b/xml/System.Security.Cryptography.Pkcs/Pkcs12KeyBag.xml @@ -53,9 +53,9 @@ to store without making a defensive copy; otherwise, . The default is . Initializes a new instance of the from an existing encoded PKCS#8 PrivateKeyInfo value. - - The parameter does not represent a single ASN.1 BER-encoded value. + The parameter does not represent a single ASN.1 BER-encoded value. @@ -100,9 +100,9 @@ Callers are therefore advised to only use a `true` value for the `skipCopy` para Gets a memory value containing the PKCS#8 PrivateKeyInfo value transported by this bag. A memory value containing the PKCS#8 PrivateKeyInfo value transported by this bag. - to store without making a defensive copy; otherwise, . The default is . Initializes a new instance of the from an existing encoded PKCS#8 EncryptedPrivateKeyInfo value. - - The parameter does not represent a single ASN.1 BER-encoded value. + The parameter does not represent a single ASN.1 BER-encoded value. @@ -97,9 +97,9 @@ Callers are therefore advised to only use a `true` value for the `skipCopy` para Gets a memory value containing the PKCS#8 EncryptedPrivateKeyInfo value transported by this bag. A memory value containing the PKCS#8 EncryptedPrivateKeyInfo value transported by this bag. - Represents an attribute used for CMS/PKCS #7 and PKCS #9 operations. - object can be thought of as a strongly typed object because of the addition of the property. - + object can be thought of as a strongly typed object because of the addition of the property. + ]]> @@ -124,10 +124,10 @@ Initializes a new instance of the class using a specified object as its attribute type and value. To be added. The length of the member of the member of is zero. - The member of is . - - -or- - + The member of is . + + -or- + The member of the member of is . @@ -242,7 +242,7 @@ Copies a PKCS #9 attribute type and value for this from the specified object. To be added. - does not represent a compatible attribute type. + does not represent a compatible attribute type. is . diff --git a/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml b/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml index 968be46de02..c18351f1638 100644 --- a/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml +++ b/xml/System.Security.Cryptography.X509Certificates/CertificateRequest.xml @@ -638,7 +638,7 @@ The object with the specified values. The returned object won't assert . To be added. - is . + is . -or- @@ -1211,7 +1211,7 @@ This object was created with a constructor which did not accept a signing key. The binary PKCS#10 signing request to load. The hash algorithm to use when creating a certificate or new signing request. - When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. + When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. A bitwise combination of the enumeration values that specifies how to load the request. The RSA Signature Padding to use when creating a certificate from this request. For RSA signing certificates using the default signature generator, this parameter is required; otherwise, this parameter is ignored. Loads a binary PKCS#10 signing request as a new CertificateRequest instance. @@ -1285,12 +1285,12 @@ This object was created with a constructor which did not accept a signing key. . is or . - is . + is . specifies a value that is not supported. does not contain a PKCS#10 signing request. - + -or- is not a valid PKCS#10 signing request. @@ -1348,12 +1348,12 @@ This object was created with a constructor which did not accept a signing key. . is or . - is . + is . specifies a value that is not supported. does not contain a PKCS#10 signing request. - + -or- is not a valid PKCS#10 signing request. diff --git a/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml b/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml index 9599d7616fc..bad277c0c4b 100644 --- a/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml +++ b/xml/System.Security.Cryptography.X509Certificates/X509Certificate.xml @@ -254,8 +254,6 @@ If you create an certificate by specifying a PKCS7 signed file store for `data`, the is created for the certificate that signed the store rather than for any of the certificates within the store. - - ## Examples The following example loads an X.509 certificate file into an object, exports the certificate as a byte array, and then imports the byte array into another object. @@ -272,11 +270,11 @@ - The certificate is invalid. - The certificate's password is incorrect. - The parameter is . + The parameter is . -or- - The length of the parameter is 0. + The length of the parameter is 0. @@ -1651,7 +1649,7 @@ An object to compare to the current object. Compares two objects for equality. - if the current object is equal to the object specified by the parameter; otherwise, . + if the current object is equal to the object specified by the parameter; otherwise, . The index into to begin copying. Copies the values in the current to a one-dimensional instance at the specified index. To be added. - The parameter is multidimensional. - - -or- - - The number of elements in the is greater than the available space between and the end of . + The parameter is multidimensional. + + -or- + + The number of elements in the is greater than the available space between and the end of . The parameter is . - The parameter is less than the parameter's lower bound. + The parameter is less than the parameter's lower bound. @@ -993,7 +993,7 @@ ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1036,7 +1036,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1078,7 +1078,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1121,7 +1121,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1167,7 +1167,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1214,7 +1214,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1260,7 +1260,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1307,7 +1307,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1350,7 +1350,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1393,7 +1393,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1439,7 +1439,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> @@ -1484,7 +1484,7 @@ This member is an explicit interface member implementation. It can be used only ## Remarks -This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. +This member is an explicit interface member implementation. It can be used only when the instance is cast to an interface. ]]> diff --git a/xml/System.Security.Cryptography.Xml/CipherData.xml b/xml/System.Security.Cryptography.Xml/CipherData.xml index a1dea8c12a2..3eabc48b0c2 100644 --- a/xml/System.Security.Cryptography.Xml/CipherData.xml +++ b/xml/System.Security.Cryptography.Xml/CipherData.xml @@ -38,25 +38,25 @@ Represents the element in XML encryption. This class cannot be inherited. - class represents the `` element in XML encryption. It is a required element that provides the encrypted data. It must either contain the encrypted data as base64-encoded text of the `` element, or provide a reference to an external location containing the encrypted data using the `` element. - - In many cases, you do not need to directly create a new instance of the class. The , , and classes create instances for you. - + class represents the `` element in XML encryption. It is a required element that provides the encrypted data. It must either contain the encrypted data as base64-encoded text of the `` element, or provide a reference to an external location containing the encrypted data using the `` element. + + In many cases, you do not need to directly create a new instance of the class. The , , and classes create instances for you. + > [!NOTE] -> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example uses the class to create an `` element that contains a `` element, and then writes the XML to an XML file. - +> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example uses the class to create an `` element that contains a `` element, and then writes the XML to an XML file. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/Overview/encrypteddata.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet1"::: + ]]> @@ -97,20 +97,20 @@ Initializes a new instance of the class. - object that represents the `` element in XML encryption. The `` element is a required element in XML encryption. - - - -## Examples - The following code example shows how to create a new instance of the class. The entire sample can be found in the class topic. - + object that represents the `` element in XML encryption. The `` element is a required element in XML encryption. + + + +## Examples + The following code example shows how to create a new instance of the class. The entire sample can be found in the class topic. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/Overview/encrypteddata.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: + ]]> @@ -146,23 +146,23 @@ The encrypted data to use for the element. Initializes a new instance of the class using a byte array as the value. - object that represents the `` element in XML encryption. The constructor assigns the `cipherValue` value to the property as the actual encrypted data. - + object that represents the `` element in XML encryption. The constructor assigns the `cipherValue` value to the property as the actual encrypted data. + > [!NOTE] -> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class. - +> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example shows how to create a new instance of the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/CPP/encrypteddata.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/encrypteddata.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: + ]]> The parameter is . @@ -200,26 +200,24 @@ The object to use. Initializes a new instance of the class using a object. - object that represents the `` element in XML encryption and assigns the `cipherReference` value to the property. The object represents the `` element, which provides the location of the encrypted data. - + object that represents the `` element in XML encryption and assigns the `cipherReference` value to the property. The object represents the `` element, which provides the location of the encrypted data. + > [!NOTE] -> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class using information. - +> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. + +## Examples + The following code example shows how to create a new instance of the class using information. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> - The parameter is . + The parameter is . The property has already been set. @@ -255,23 +253,23 @@ Gets or sets the element. A object. - ` element identifies a source which, when processed, yields the encrypted data. For more information about this element, see . - + ` element identifies a source which, when processed, yields the encrypted data. For more information about this element, see . + > [!NOTE] -> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class using information. - +> A object can have either a property or a property, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example shows how to create a new instance of the class using information. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.CipherReference/CPP/example.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/example.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.CipherReference/VB/example.vb" id="Snippet1"::: + ]]> The property was set to . @@ -310,23 +308,23 @@ Gets or sets the element. A byte array that represents the element. - [!NOTE] -> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. - - - -## Examples - The following code example shows how to create a new instance of the class. - +> The `` element can have either a or a child element, but not both. A is thrown if both are assigned to a object. + + + +## Examples + The following code example shows how to create a new instance of the class. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/CPP/encrypteddata.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/.ctor/encrypteddata.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptography.Xml.EncryptedData2/VB/encrypteddata.vb" id="Snippet1"::: + ]]> The property was set to . @@ -365,20 +363,20 @@ Gets the XML values for the object. A object that represents the XML information for the object. - object. - - - -## Examples - The following code example demonstrates how to create a new instance of the object. - + object. + + + +## Examples + The following code example demonstrates how to create a new instance of the object. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/cpp/encrypteddata.cpp" id="Snippet2"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/CipherData/Overview/encrypteddata.cs" id="Snippet2"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/cryptgraphy.Xml.EncryptedData/VB/encrypteddata.vb" id="Snippet2"::: + ]]> The property and the property are . @@ -428,11 +426,11 @@ An that represents the XML data to load. Loads XML data from an into a object. - method overwrites existing XML elements with the `value` parameter. - + method overwrites existing XML elements with the `value` parameter. + ]]> The parameter is . diff --git a/xml/System.Security.Cryptography.Xml/EncryptedXml.xml b/xml/System.Security.Cryptography.Xml/EncryptedXml.xml index b662bd1cdb6..bd0c9dc257e 100644 --- a/xml/System.Security.Cryptography.Xml/EncryptedXml.xml +++ b/xml/System.Security.Cryptography.Xml/EncryptedXml.xml @@ -38,60 +38,60 @@ Represents the process model for implementing XML encryption. - class is the main class used for XML encryption in the .NET Framework. XML Encryption is a standards-based, interoperable way to encrypt all or part of an XML document or any arbitrary data. The .NET Framework XML encryption classes implement the World Wide Web Consortium (W3C) [XML Encryption Syntax and Processing Version 1.0](https://www.w3.org/TR/2002/REC-xmlenc-core-20021210/) specification. - - Use the class whenever you need to share encrypted XML data between applications or organizations in a standard way. Any data encrypted using this class can be decrypted by any implementation of the W3C specification for XML encryption. - - XML encryption replaces any plain text XML element or document with the `` element, which contains an encrypted (or cipher text) representation of plain text XML or any arbitrary data. The `` element can optionally contain information about where to find a key that will decrypt the cipher text, and which cryptographic algorithm was used to encrypt the plain text. - - The `` element is similar to the `` element in style and usage, except that it allows you to encrypt a key that will decrypt the value of the `` element. Note that the `` element and the `` element will never contain an unencrypted key. - - Use one of the following methods to exchange key information: - -- Do not include any key information. If you choose this option, both parties must agree on an algorithm and key before they exchange encrypted data. - -- Include the location of the key in the Uniform Resource Identifier (URI) attribute of the `` element. Both parties must agree on the key location ahead of time and this location must be kept secret. - -- Include a string name that maps to a key in the `` element. Both parties must agree on the key name mapping before they exchange encrypted data and this mapping must be kept secret. - -- Include an encrypted key in the `` element. Both parties must agree on the key that decrypts the encrypted key before they exchange encrypted data. You can optionally include a name or location of the key that will decrypt the key in the `` element. - - - -## Examples - The following code example demonstrates how to create a simple utility class that uses the algorithm to encrypt an XML document. - + class is the main class used for XML encryption in the .NET Framework. XML Encryption is a standards-based, interoperable way to encrypt all or part of an XML document or any arbitrary data. The .NET Framework XML encryption classes implement the World Wide Web Consortium (W3C) [XML Encryption Syntax and Processing Version 1.0](https://www.w3.org/TR/2002/REC-xmlenc-core-20021210/) specification. + + Use the class whenever you need to share encrypted XML data between applications or organizations in a standard way. Any data encrypted using this class can be decrypted by any implementation of the W3C specification for XML encryption. + + XML encryption replaces any plain text XML element or document with the `` element, which contains an encrypted (or cipher text) representation of plain text XML or any arbitrary data. The `` element can optionally contain information about where to find a key that will decrypt the cipher text, and which cryptographic algorithm was used to encrypt the plain text. + + The `` element is similar to the `` element in style and usage, except that it allows you to encrypt a key that will decrypt the value of the `` element. Note that the `` element and the `` element will never contain an unencrypted key. + + Use one of the following methods to exchange key information: + +- Do not include any key information. If you choose this option, both parties must agree on an algorithm and key before they exchange encrypted data. + +- Include the location of the key in the Uniform Resource Identifier (URI) attribute of the `` element. Both parties must agree on the key location ahead of time and this location must be kept secret. + +- Include a string name that maps to a key in the `` element. Both parties must agree on the key name mapping before they exchange encrypted data and this mapping must be kept secret. + +- Include an encrypted key in the `` element. Both parties must agree on the key that decrypts the encrypted key before they exchange encrypted data. You can optionally include a name or location of the key that will decrypt the key in the `` element. + + + +## Examples + The following code example demonstrates how to create a simple utility class that uses the algorithm to encrypt an XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.MainXMLEncDecryptDataOOP/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.MainXMLEncDecryptDataOOP/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.MainXMLEncDecryptDataOOP/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/CPP/Cryptography.XML.XMLEncMapKey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample2.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CPP/Cryptography.XML.XMLEncMapKeyX509.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample3.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: + ]]> @@ -104,33 +104,33 @@ Initializes a new instance of the class. - @@ -172,38 +172,38 @@ Initializes a new instance of the class. - @@ -249,26 +249,26 @@ An object used to initialize the object. Initializes a new instance of the class using the specified XML document. - object when you want to specify the XML document to encrypt. The `document` parameter comprises the XML elements that later form the encrypted XML. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + object when you want to specify the XML document to encrypt. The `document` parameter comprises the XML elements that later form the encrypted XML. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/CPP/Cryptography.XML.XMLEncMapKey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample2.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> @@ -324,11 +324,11 @@ An object associated with the object. Initializes a new instance of the class using the specified XML document and evidence. - object when you want to specify the XML document to encrypt and provide security evidence. The `document` parameter comprises the XML elements that later form the encrypted XML. - + object when you want to specify the XML document to encrypt and provide security evidence. The `document` parameter comprises the XML elements that later form the encrypted XML. + ]]> @@ -369,28 +369,28 @@ The symmetric key to map to . Defines a mapping between a key name and a symmetric key or an asymmetric key. - method allows you to map a symmetric key or an asymmetric key to a string name. This method adds the values of the `keyName` and `keyObject` parameters to a table of valid key name mappings. - - Use the method to clear the key name mappings table. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + method allows you to map a symmetric key or an asymmetric key to a string name. This method adds the values of the `keyName` and `keyObject` parameters to a table of valid key name mappings. + + Use the method to clear the key name mappings table. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/CPP/Cryptography.XML.XMLEncMinimalDecrypt.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/AddKeyNameMapping/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the parameter is not an RSA algorithm or a symmetric key. @@ -426,11 +426,11 @@ Resets all key name mapping. - method. - + method. + ]]> @@ -472,28 +472,28 @@ Decrypts an element using the specified symmetric algorithm. A byte array that contains the raw decrypted plain text. - method to decrypt an element using a symmetric key. - - Note that the method only decrypts top-level `` tags. In cases where one or more `` tags have been encrypted and are contained within higher level `` tags, you can call the method separately for each one. See the method for a code example. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + method to decrypt an element using a symmetric key. + + Note that the method only decrypts top-level `` tags. In cases where one or more `` tags have been encrypted and are contained within higher level `` tags, you can call the method separately for each one. See the method for a code example. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -538,38 +538,38 @@ Decrypts all elements of the XML document that were specified during initialization of the class. - method decrypts all `` elements of the XML document loaded during initialization. After you call this method, all `` elements in the document are replaced with plain text versions. - - The method decrypts only top-level `` elements. If you need to decrypt a super-encrypted document (a document that is encrypted more than once), you must call the method repeatedly until all the `` elements have been decrypted. - + method decrypts all `` elements of the XML document loaded during initialization. After you call this method, all `` elements in the document are replaced with plain text versions. + + The method decrypts only top-level `` elements. If you need to decrypt a super-encrypted document (a document that is encrypted more than once), you must call the method repeatedly until all the `` elements have been decrypted. + > [!NOTE] -> The method decrypts only valid XML data. To decrypt arbitrary data, use the method. - - To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - +> The method decrypts only valid XML data. To decrypt arbitrary data, use the method. + + To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CPP/Cryptography.XML.XMLEncMapKeyX509.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample3.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to decrypt a high level `` tag that contains another encrypted `` tag. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to decrypt a high level `` tag that contains another encrypted `` tag. + :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/DecryptDocument/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Misc/Cryptography.XML.EncryptedDocument.DecryptDocument-SuperEncryption/VB/sample.vb" id="Snippet1"::: + ]]> The cryptographic key used to decrypt the document was not found. @@ -627,13 +627,13 @@ Determines the key represented by the element. A byte array that contains the key. - method decrypts an encrypted key contained within the `` element of an XML document. - - This recursive method finds the key represented by the object. Note that an object can contain another object that specifies its value. - + method decrypts an encrypted key contained within the `` element of an XML document. + + This recursive method finds the key represented by the object. Note that an object can contain another object that specifies its value. + ]]> The value of the parameter is . @@ -648,11 +648,11 @@ Decrypts an element. - method to decrypt an `` element and retrieve the key used to decrypt that element. - + method to decrypt an `` element and retrieve the key used to decrypt that element. + ]]> @@ -694,17 +694,17 @@ Decrypts an element using a symmetric algorithm. A byte array that contains the plain text key. - method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). - + method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the element is not the Triple DES Key Wrap algorithm or the Advanced Encryption Standard (AES) Key Wrap algorithm (also called Rijndael). @@ -748,17 +748,17 @@ Decrypts an element using an asymmetric algorithm. A byte array that contains the plain text key. - method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `rsa` parameter that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP padding). - + method decrypts an encrypted key contained within the `` element of an XML document. This method accepts a value for the `rsa` parameter that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP padding). + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -800,11 +800,11 @@ Gets or sets the evidence of the object from which the object is constructed. An object. - object has any security evidence, you should add the evidence to the property. If you do not set this property, any associated objects will not be dereferenced because they will not be granted the required permission set. - + object has any security evidence, you should add the evidence to the property. If you do not set this property, any associated objects will not be dereferenced because they will not be granted the required permission set. + ]]> @@ -840,11 +840,11 @@ Gets or sets the encoding used for XML encryption. An object. - class, such as UTF-16 or ASCII. - + class, such as UTF-16 or ASCII. + ]]> @@ -857,21 +857,21 @@ Encrypts the outer XML of an element using the specified certificate or key in the key mapping table. - @@ -923,30 +923,30 @@ Encrypts the outer XML of an element using the specified X.509 certificate. An element that represents the encrypted XML data. - method is a convenient way to encrypt the outer XML of an element using a certificate. This method generates a 256-bit Advanced Encryption Standard (AES) session key to encrypt an XML element and then encrypts and signs the AES key using the object. The method then returns the resulting XML as an element. - - If you need more control over the encryption, so you can place the encrypted information into a `` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. - - To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. - + method is a convenient way to encrypt the outer XML of an element using a certificate. This method generates a 256-bit Advanced Encryption Standard (AES) session key to encrypt an XML element and then encrypts and signs the AES key using the object. The method then returns the resulting XML as an element. + + If you need more control over the encryption, so you can place the encrypted information into a `` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. + + To use XML Encryption with X.509 certificates, you must have the Microsoft Enhanced Cryptographic Provider installed and the X.509 certificate must use the Enhanced Provider. If you do not have the Microsoft Enhanced Cryptographic Provider installed or the X.509 certificate does not use the Enhanced Provider, a with an "Unknown Error" will be thrown when you decrypt an XML document. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an X.509 certificate. This example creates a symmetric session key to encrypt the document and then uses the X.509 certificate to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/CPP/Cryptography.XML.XMLEncMapKeyX509.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample3.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKeyX509/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the parameter does not represent an RSA key algorithm. @@ -998,33 +998,33 @@ Encrypts the outer XML of an element using the specified key in the key mapping table. An object that represents the encrypted XML data. - ` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. - - For a list of all supported algorithms, see the list of constant fields associated with the class. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. - + ` element or specify whether the entire XML element or just its contents should be encrypted, use the method overloads. + + For a list of all supported algorithms, see the list of constant fields associated with the class. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/CPP/Cryptography.XML.XMLEncMinimalDecrypt.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/AddKeyNameMapping/sample.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecrypt/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . - The value of the parameter does not match a registered key name pair. - - -or- - + The value of the parameter does not match a registered key name pair. + + -or- + The cryptographic key described by the parameter is not supported. @@ -1036,27 +1036,27 @@ Encrypts XML data using a symmetric algorithm. - @@ -1098,38 +1098,38 @@ Encrypts data in the specified byte array using the specified symmetric algorithm. A byte array of encrypted data. - ` element. This method assumes that the data specified in the `plaintext` parameter is a byte array that contains XML data. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + ` element. This method assumes that the data specified in the `plaintext` parameter is a byte array that contains XML data. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example embeds a key name in the encrypted XML document that the decrypting method uses to find the appropriate decryption key. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/CPP/Cryptography.XML.XMLEncMapKey.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample2.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: - - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMapKey/VB/sample.vb" id="Snippet1"::: + + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The data could not be encrypted using the specified parameters. @@ -1174,26 +1174,26 @@ Encrypts the specified element or its contents using the specified symmetric algorithm. A byte array that contains the encrypted data. - ` element. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + ` element. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1205,20 +1205,20 @@ Encrypts the key that a recipient uses to decrypt an element. - method to encrypt the key that a recipient uses to decrypt an `` element. This method places the encrypted key within an `` element. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + method to encrypt the key that a recipient uses to decrypt an `` element. This method places the encrypted key within an `` element. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> @@ -1260,19 +1260,19 @@ Encrypts a key using a symmetric algorithm that a recipient uses to decrypt an element. A byte array that represents the encrypted value of the parameter. - method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). - - Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. - + method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for the `symmetricAlgorithm` parameter that represents either the Triple DES algorithm or the AES key wrap algorithm (also called Rijndael). + + Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . The value of the parameter is not the Triple DES Key Wrap algorithm or the Advanced Encryption Standard (AES) Key Wrap algorithm (also called Rijndael). @@ -1316,28 +1316,28 @@ Encrypts the key that a recipient uses to decrypt an element. A byte array that represents the encrypted value of the parameter. - method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for `rsa` that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP). - - Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + method to encrypt the key that a recipient uses to decrypt an `` element. This method accepts a value for `rsa` that represents either the RSA PKCS#1 v1.5 algorithm or the RSA PKCS#1 type 2 algorithm (also called OAEP). + + Note that this method does not automatically place the encrypted key within an `` element. You must manually create the `` element within your document. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1386,21 +1386,21 @@ Retrieves the decryption initialization vector (IV) from an object. A byte array that contains the decryption initialization vector (IV). - object, this method retrieves the decryption initialization vector (IV). The default behavior retrieves the IV as the first bytes of the byte array. - - For a list of Uniform Resource Identifier (URI) values supported by the `symmetricAlgorithmUri` parameter, see the list of constant fields associated with the class. - + object, this method retrieves the decryption initialization vector (IV). The default behavior retrieves the IV as the first bytes of the byte array. + + For a list of Uniform Resource Identifier (URI) values supported by the `symmetricAlgorithmUri` parameter, see the list of constant fields associated with the class. + ]]> The value of the parameter is . - The value of the parameter has an property that is null. - - -or- - - The value of the parameter is not a supported algorithm. + The value of the parameter has an property that is null. + + -or- + + The value of the parameter is not a supported algorithm. @@ -1458,18 +1458,18 @@ Retrieves the decryption key from the specified object. A object associated with the decryption key. - object, this method looks for the decryption key that can be used to retrieve the plain text data. If a key name is specified, the method looks for the symmetric algorithm or asymmetric algorithm that is associated with the key name as defined in the key name mapping. Otherwise, if a retrieval method or an object is specified, the method loads the object and calls the method. - + object, this method looks for the decryption key that can be used to retrieve the plain text data. If a key name is specified, the method looks for the symmetric algorithm or asymmetric algorithm that is associated with the key name as defined in the key name mapping. Otherwise, if a retrieval method or an object is specified, the method loads the object and calls the method. + ]]> The value of the parameter is . - The encryptedData parameter has an property that is null. - - -or- - + The encryptedData parameter has an property that is null. + + -or- + The encrypted key cannot be retrieved using the specified parameters. @@ -1517,11 +1517,11 @@ Determines how to resolve internal Uniform Resource Identifier (URI) references. An object that contains an ID indicating how internal Uniform Resource Identifiers (URIs) are to be resolved. - method determines how to resolve internal Uniform Resource Identifiers (URIs). It looks for elements with a specified value or for elements with an ID attribute that has a specified value. - + method determines how to resolve internal Uniform Resource Identifiers (URIs). It looks for elements with a specified value or for elements with an ID attribute that has a specified value. + ]]> @@ -1557,11 +1557,11 @@ Gets or sets the cipher mode used for XML encryption. One of the values. - enumeration, such as Cipher Feedback (CFB) mode. - + enumeration, such as Cipher Feedback (CFB) mode. + ]]> @@ -1597,11 +1597,11 @@ Gets or sets the padding mode used for XML encryption. One of the values that specifies the type of padding used for encryption. - enumeration, such as ANSI X9.23 or PKCS#5. - + enumeration, such as ANSI X9.23 or PKCS#5. + ]]> @@ -1637,13 +1637,13 @@ Gets or sets the recipient of the encrypted key information. The recipient of the encrypted key information. - object referenced by a key name by examining the property. - - Use the property to identify the element that the current recipient can decrypt to retrieve a decryption key. - + object referenced by a key name by examining the property. + + Use the property to identify the element that the current recipient can decrypt to retrieve a decryption key. + ]]> @@ -1684,26 +1684,26 @@ The decrypted data to replace with. Replaces an element with a specified decrypted sequence of bytes. - method replaces an `` element with the value of the `decryptedData` parameter. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + method replaces an `` element with the value of the `decryptedData` parameter. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1746,26 +1746,26 @@ to replace only the contents of the element; to replace the entire element. Replaces the specified element with the specified object. - method replaces the `inputElement` parameter with the value specified by the `encryptedData` parameter. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + method replaces the `inputElement` parameter with the value specified by the `encryptedData` parameter. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> - The value of the parameter is . - - -or- - + The value of the parameter is . + + -or- + The value of the parameter is . @@ -1807,11 +1807,11 @@ Gets or sets the object used by the Document Object Model (DOM) to resolve external XML references. An object. - object used to resolve external XML resources such as entities, document type definitions (DTDs), or schemas. - + object used to resolve external XML resources such as entities, document type definitions (DTDs), or schemas. + ]]> @@ -1878,11 +1878,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the 128-bit Advanced Encryption Standard (AES) Key Wrap algorithm (also known as the Rijndael Key Wrap algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-aes128)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-aes128)`. + ]]> @@ -1917,20 +1917,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the 128-bit Advanced Encryption Standard (AES) algorithm (also known as the Rijndael algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#aes128-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#aes128-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -1965,11 +1965,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the 192-bit Advanced Encryption Standard (AES) Key Wrap algorithm (also known as the Rijndael Key Wrap algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-aes192)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-aes192)`. + ]]> @@ -2004,20 +2004,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the 192-bit Advanced Encryption Standard (AES) algorithm (also known as the Rijndael algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#aes192-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#aes192-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2052,11 +2052,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the 256-bit Advanced Encryption Standard (AES) Key Wrap algorithm (also known as the Rijndael Key Wrap algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-aes256)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-aes256)`. + ]]> @@ -2091,20 +2091,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the 256-bit Advanced Encryption Standard (AES) algorithm (also known as the Rijndael algorithm). This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#aes256-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#aes256-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2139,20 +2139,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the Digital Encryption Standard (DES) algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#des-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#des-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2187,11 +2187,11 @@ Represents the namespace Uniform Resource Identifier (URI) for XML encryption element content. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#Content)`. - + field is `http://www.w3.org/(2001/04/xmlenc#Content)`. + ]]> @@ -2226,20 +2226,20 @@ Represents the namespace Uniform Resource Identifier (URI) for an XML encryption element. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#Element)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#Element)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2274,11 +2274,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the XML encryption element. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#EncryptedKey)`. - + field is `http://www.w3.org/(2001/04/xmlenc#EncryptedKey)`. + ]]> @@ -2313,11 +2313,11 @@ Represents the namespace Uniform Resource Identifier (URI) for XML encryption syntax and processing. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#)`. - + field is `http://www.w3.org/(2001/04/xmlenc#)`. + ]]> @@ -2352,20 +2352,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the RSA Public Key Cryptography Standard (PKCS) Version 1.5 algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#rsa-1_5)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#rsa-1_5)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using an asymmetric key. This example creates a symmetric session key to encrypt the document and then uses the asymmetric key to embed an encrypted version of the session key into the XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/CPP/sample.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample1.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncImbedKey/VB/sample.vb" id="Snippet1"::: + ]]> @@ -2400,11 +2400,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the RSA Optimal Asymmetric Encryption Padding (OAEP) encryption algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#rsa-oaep-mgf1p)`. - + field is `http://www.w3.org/(2001/04/xmlenc#rsa-oaep-mgf1p)`. + ]]> @@ -2439,11 +2439,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the SHA-256 algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#sha256)`. - + field is `http://www.w3.org/(2001/04/xmlenc#sha256)`. + ]]> @@ -2478,11 +2478,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the SHA-512 algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#sha512)`. - + field is `http://www.w3.org/(2001/04/xmlenc#sha512)`. + ]]> @@ -2517,11 +2517,11 @@ Represents the namespace Uniform Resource Identifier (URI) for the TRIPLEDES key wrap algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#kw-tripledes)`. - + field is `http://www.w3.org/(2001/04/xmlenc#kw-tripledes)`. + ]]> @@ -2556,20 +2556,20 @@ Represents the namespace Uniform Resource Identifier (URI) for the Triple DES algorithm. This field is constant. - field is `http://www.w3.org/(2001/04/xmlenc#tripledes-cbc)`. - - - -## Examples - The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. - + field is `http://www.w3.org/(2001/04/xmlenc#tripledes-cbc)`. + + + +## Examples + The following code example demonstrates how to encrypt an XML document using a symmetric key. This example does not include any key information in the encrypted XML document. + :::code language="cpp" source="~/snippets/cpp/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/CPP/Cryptography.XML.XMLEncMinimalDecryptData.cpp" id="Snippet1"::: :::code language="csharp" source="~/snippets/csharp/System.Security.Cryptography.Xml/EncryptedXml/Overview/sample4.cs" id="Snippet1"::: - :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: - + :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_CLR/Cryptography.XML.XMLEncMinimalDecryptData/VB/sample.vb" id="Snippet1"::: + ]]> diff --git a/xml/System.Security.Cryptography/CryptoStream.xml b/xml/System.Security.Cryptography/CryptoStream.xml index eb6a6674b06..3c9ead8a98c 100644 --- a/xml/System.Security.Cryptography/CryptoStream.xml +++ b/xml/System.Security.Cryptography/CryptoStream.xml @@ -696,7 +696,7 @@ This method stores in the task it returns all non-usage exceptions that the meth is . - is negative or zero. + is negative or zero. Either the current stream or the destination stream is disposed. The current stream does not support reading, or the destination stream does not support writing. An error occurred during a cryptographic operation. diff --git a/xml/System.Security.Cryptography/CryptographicAttributeObjectCollection.xml b/xml/System.Security.Cryptography/CryptographicAttributeObjectCollection.xml index cf1821f3376..1bff56f3080 100644 --- a/xml/System.Security.Cryptography/CryptographicAttributeObjectCollection.xml +++ b/xml/System.Security.Cryptography/CryptographicAttributeObjectCollection.xml @@ -48,11 +48,11 @@ Contains a set of objects. - - + + ]]> @@ -224,15 +224,13 @@ if the method returns the zero-based index of the added item; otherwise, . - - + + ]]> - - is . A cryptographic operation could not be completed. The specified item already exists in the collection. @@ -394,11 +392,11 @@ if access to the collection is thread safe; otherwise . - diff --git a/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml b/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml index f3fe2e01573..abb27e99e12 100644 --- a/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml +++ b/xml/System.Security.Cryptography/DSACryptoServiceProvider.xml @@ -1843,7 +1843,7 @@ This algorithm supports key lengths from 512 bits to 1024 bits in increments of The data signed with . - The signature to be verified for . + The signature to be verified for . Verifies the signature for the specified data. if matches the signature computed using the specified hash algorithm and key on ; otherwise, . diff --git a/xml/System.Security.Cryptography/DpapiDataProtector.xml b/xml/System.Security.Cryptography/DpapiDataProtector.xml index 10f53b53df8..1637ef8a0de 100644 --- a/xml/System.Security.Cryptography/DpapiDataProtector.xml +++ b/xml/System.Security.Cryptography/DpapiDataProtector.xml @@ -16,15 +16,15 @@ Provides simple data protection methods. - class provides a structured way to protect data by using the class. The class constructor has purpose parameters that serve like a password to identify the protected data. All three parameters are hashed and included as part of the encrypted data string. You must know the purpose parameters to unprotect the data. The method that is called to encrypt the data has an `optionalEntropy` parameter that allows you to add qualifying information to encrypt the data more securely. The hash of the purpose parameters is used for optional entropy. Because you do not need a key to decrypt the data, carefully choosing the purpose data adds another level of security to data protection. - - If you use a setting of , only a user with logon credentials that match those of the user who encrypted the data can decrypt the data. In addition, decryption usually can be done only on the computer where the data was encrypted. The Windows function that encrypts the data creates a session key to perform the encryption. The session key is derived again when the data is to be decrypted. For a detailed description of how data is protected by using session keys, see [Windows Data Protection](https://go.microsoft.com/fwlink/?LinkId=224686). - - If you use a setting of when protecting the data and do not carefully identify the purpose parameters, any other application on that computer that knows the purposes can access and unprotect the data. - + class provides a structured way to protect data by using the class. The class constructor has purpose parameters that serve like a password to identify the protected data. All three parameters are hashed and included as part of the encrypted data string. You must know the purpose parameters to unprotect the data. The method that is called to encrypt the data has an `optionalEntropy` parameter that allows you to add qualifying information to encrypt the data more securely. The hash of the purpose parameters is used for optional entropy. Because you do not need a key to decrypt the data, carefully choosing the purpose data adds another level of security to data protection. + + If you use a setting of , only a user with logon credentials that match those of the user who encrypted the data can decrypt the data. In addition, decryption usually can be done only on the computer where the data was encrypted. The Windows function that encrypts the data creates a session key to perform the encryption. The session key is derived again when the data is to be decrypted. For a detailed description of how data is protected by using session keys, see [Windows Data Protection](https://go.microsoft.com/fwlink/?LinkId=224686). + + If you use a setting of when protecting the data and do not carefully identify the purpose parameters, any other application on that computer that knows the purposes can access and unprotect the data. + ]]> @@ -65,23 +65,23 @@ The specific purpose(s) for the data protector. Creates a new instance of the class by using the specified application name, primary purpose, and specific purposes. - ** or **Invoice** and **\**. - + ** or **Invoice** and **\**. + ]]> - is an empty string or . - - -or- - - is an empty string or . - - -or- - - contains an empty string or . + is an empty string or . + + -or- + + is an empty string or . + + -or- + + contains an empty string or . @@ -108,11 +108,11 @@ if the data must be re-encrypted; otherwise, . - @@ -219,11 +219,11 @@ Gets or sets the scope of the data protection. One of the enumeration values that specifies the scope of the data protection (either the current user or the local machine). The default is . - to , only applications running on your credentials can unprotect the data; however, that means that any application running on your credentials can access the protected data. If you set the to , any full-trust application on the computer can unprotect, access, and modify the data if it knows the application name, the primary purpose, and the specific purpose. - + to , only applications running on your credentials can unprotect the data; however, that means that any application running on your credentials can access the protected data. If you set the to , any full-trust application on the computer can unprotect, access, and modify the data if it knows the application name, the primary purpose, and the specific purpose. + ]]> diff --git a/xml/System.Security.Cryptography/RC2.xml b/xml/System.Security.Cryptography/RC2.xml index 4e700e1b8a0..f59d8d9be8d 100644 --- a/xml/System.Security.Cryptography/RC2.xml +++ b/xml/System.Security.Cryptography/RC2.xml @@ -69,13 +69,13 @@ Represents the base class from which all implementations of the algorithm must derive. - [!NOTE] -> A newer symmetric encryption algorithm, Advanced Encryption Standard (AES), is available. Consider using the algorithm and its derived classes instead of the class. Use only for compatibility with legacy applications and data. - +> A newer symmetric encryption algorithm, Advanced Encryption Standard (AES), is available. Consider using the algorithm and its derived classes instead of the class. Use only for compatibility with legacy applications and data. + ]]> Cryptographic Services @@ -123,21 +123,21 @@ Initializes a new instance of . - implementation only supports key lengths from 40 bits to 128 bits in increments of 8 bits. - - This method initializes the protected fields of to the default values listed in the following table. - -|Field|Default Value| -|-----------|-------------------| -||128| -||64| -||64| - + implementation only supports key lengths from 40 bits to 128 bits in increments of 8 bits. + + This method initializes the protected fields of to the default values listed in the following table. + +|Field|Default Value| +|-----------|-------------------| +||128| +||64| +||64| + ]]> Cryptographic Services @@ -210,26 +210,26 @@ Creates an instance of a cryptographic object to perform the algorithm. An instance of a cryptographic object. - The algorithm was used with Federal Information Processing Standards (FIPS) mode enabled, but is not FIPS compatible. @@ -303,7 +303,7 @@ Creates an instance of a cryptographic object to perform the specified implementation of the algorithm. An instance of a cryptographic object. To be added. - The algorithm described by the parameter was used with Federal Information Processing Standards (FIPS) mode enabled, but is not FIPS compatible. + The algorithm described by the parameter was used with Federal Information Processing Standards (FIPS) mode enabled, but is not FIPS compatible. Cryptographic Services @@ -394,11 +394,11 @@ Represents the effective size of the secret key used by the algorithm in bits. - property. - + property. + ]]> Cryptographic Services @@ -446,11 +446,11 @@ Gets or sets the size of the secret key used by the algorithm in bits. The size of the secret key used by the algorithm. - The value for the RC2 key size is less than the effective key size value. diff --git a/xml/System.Security.Cryptography/RSA.xml b/xml/System.Security.Cryptography/RSA.xml index 7728f18f4ed..cf730ef32b1 100644 --- a/xml/System.Security.Cryptography/RSA.xml +++ b/xml/System.Security.Cryptography/RSA.xml @@ -68,12 +68,12 @@ Represents the base class from which all implementations of the algorithm inherit. - Cryptographic Services @@ -124,11 +124,11 @@ Developers are encouraged to program against the `RSA` base class rather than an Initializes a new instance of the class. - . You cannot create an instance of an abstract class. - + . You cannot create an instance of an abstract class. + ]]> Cryptographic Services @@ -437,18 +437,18 @@ Developers are encouraged to program against the `RSA` base class rather than an or is . A derived class must override this method. - is unknown, or not supported by this implementation. - --or- - -The length of is not equal to the number of bytes for . - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +The length of is not equal to the number of bytes for . + +-or- + +This instance represents only a public key. + +-or- + The decryption operation failed. @@ -497,12 +497,12 @@ The decryption operation failed. is . - is unknown, or not supported by this implementation. - --or- - + is unknown, or not supported by this implementation. + +-or- + The decryption operation failed. - This implementation has not implemented one of or + This implementation has not implemented one of or . @@ -553,12 +553,12 @@ The decryption operation failed. is . The buffer in is too small to hold the decrypted data. - is unknown, or not supported by this implementation. - --or- - + is unknown, or not supported by this implementation. + +-or- + The decryption operation failed. - This implementation has not implemented one of or + This implementation has not implemented one of or . @@ -622,11 +622,11 @@ The decryption operation failed. When overridden in a derived class, decrypts the input data using the private key. The resulting decryption of the parameter in plain text. - , also threw a exception. - + , also threw a exception. + ]]> This method call is not supported. This exception is thrown starting with the .NET Framework 4.6. @@ -691,14 +691,14 @@ The decryption operation failed. or is . A derived class must override this method. - is unknown, or not supported by this implementation. - --or- - -The length of is too long for the combination of and the selected padding. - --or- - + is unknown, or not supported by this implementation. + +-or- + +The length of is too long for the combination of and the selected padding. + +-or- + The encryption operation failed. @@ -747,16 +747,16 @@ The encryption operation failed. is . - is unknown, or not supported by this implementation. - --or- - -The length of data is too long for the combination of and the selected padding. - --or- - + is unknown, or not supported by this implementation. + +-or- + +The length of data is too long for the combination of and the selected padding. + +-or- + The encryption operation failed. - This implementation has not implemented one of or + This implementation has not implemented one of or . @@ -807,16 +807,16 @@ The encryption operation failed. is . The buffer in is too small to hold the encrypted data. - is unknown, or not supported by this implementation. - --or- - -The length of data is too long for the combination of and the selected padding. - --or- - + is unknown, or not supported by this implementation. + +-or- + +The length of data is too long for the combination of and the selected padding. + +-or- + The encryption operation failed. - This implementation has not implemented one of or + This implementation has not implemented one of or . @@ -880,11 +880,11 @@ The encryption operation failed. When overridden in a derived class, encrypts the input data using the public key. The resulting encryption of the parameter as cipher text. - , also threw a exception. - + , also threw a exception. + ]]> This method call is not supported. This exception is thrown starting with the .NET Framework 4.6. @@ -1016,17 +1016,17 @@ The encryption operation failed. Exports the current key in the PKCS#1 RSAPrivateKey format, PEM encoded. A string containing the PEM-encoded PKCS#1 RSAPrivateKey. - The key could not be exported. @@ -1100,17 +1100,17 @@ The encryption operation failed. Exports the public-key portion of the current key in the PKCS#1 RSAPublicKey format, PEM encoded. A string containing the PEM-encoded PKCS#1 RSAPublicKey. - The key could not be exported. @@ -1161,17 +1161,17 @@ The encryption operation failed. The XML string containing key information. Initializes an object from the key information from an XML string. - initializes an RSA object using key information in an XML string that was generated using the method. The method accepts either an XML string containing a public key or an XML string containing a public and private key. - - Use the method to conveniently initialize key information. - -> [!CAUTION] -> Persisting an XML string containing a private key to an insecure location is a security threat. The security of your application can be compromised if a malicious third party can access your private key. To safely persist a private key, use a secure key container. For more information about persisting private keys in a key container, see [How to: Store Asymmetric Keys in a Key Container](/dotnet/standard/security/how-to-store-asymmetric-keys-in-a-key-container). - + initializes an RSA object using key information in an XML string that was generated using the method. The method accepts either an XML string containing a public key or an XML string containing a public and private key. + + Use the method to conveniently initialize key information. + +> [!CAUTION] +> Persisting an XML string containing a private key to an insecure location is a security threat. The security of your application can be compromised if a malicious third party can access your private key. To safely persist a private key, use a secure key container. For more information about persisting private keys in a key container, see [How to: Store Asymmetric Keys in a Key Container](/dotnet/standard/security/how-to-store-asymmetric-keys-in-a-key-container). + ]]> The parameter is . @@ -1379,37 +1379,37 @@ The encryption operation failed. When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. Imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a byte-based password, replacing the keys for this object. - - The password is incorrect. - --or- - -The contents of indicate the Key Derivation Function (KDF) to apply is the legacy PKCS#12 KDF, which requires -based passwords. - --or- - -The contents of do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. - --or- - -The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. - --or- - -The contents of represent the key in a format that is not supported. - --or- - -The algorithm-specific key import failed. + The password is incorrect. + +-or- + +The contents of indicate the Key Derivation Function (KDF) to apply is the legacy PKCS#12 KDF, which requires -based passwords. + +-or- + +The contents of do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. + +-or- + +The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. + +-or- + +The contents of represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. @@ -1452,32 +1452,32 @@ The algorithm-specific key import failed. When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. Imports the public/private keypair from a PKCS#8 EncryptedPrivateKeyInfo structure after decrypting with a char-based password, replacing the keys for this object. - - The password is incorrect. - --or- - -The contents of do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. - --or- - -The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. - --or- - -The contents of represent the key in a format that is not supported. - --or- - -The algorithm-specific key import failed. + The password is incorrect. + +-or- + +The contents of do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. + +-or- + +The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. + +-or- + +The contents of represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. @@ -1516,47 +1516,47 @@ The algorithm-specific key import failed. The bytes to use as a password when decrypting the key material. Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object. - - does not contain a PEM-encoded key with a recognized label. - --or- - - contains multiple PEM-encoded keys with a recognized label. + does not contain a PEM-encoded key with a recognized label. + +-or- + + contains multiple PEM-encoded keys with a recognized label. - -The password is incorrect. - --or- - -The base-64 decoded contents of the PEM text from do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. - --or- - -The base-64 decoded contents of the PEM text from indicate the key is for an algorithm other than the algorithm represented by this instance. - --or- - -The base-64 decoded contents of the PEM text from represent the key in a format that is not supported. - --or- - -The algorithm-specific key import failed. + +The password is incorrect. + +-or- + +The base-64 decoded contents of the PEM text from do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. + +-or- + +The base-64 decoded contents of the PEM text from indicate the key is for an algorithm other than the algorithm represented by this instance. + +-or- + +The base-64 decoded contents of the PEM text from represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. @@ -1595,47 +1595,47 @@ The algorithm-specific key import failed. The password to use for decrypting the key material. Imports an encrypted RFC 7468 PEM-encoded private key, replacing the keys for this object. - - does not contain a PEM-encoded key with a recognized label. - --or- - - contains multiple PEM-encoded keys with a recognized label. + does not contain a PEM-encoded key with a recognized label. + +-or- + + contains multiple PEM-encoded keys with a recognized label. - -The password is incorrect. - --or- - -The base-64 decoded contents of the PEM text from do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. - --or- - -The base-64 decoded contents of the PEM text from indicate the key is for an algorithm other than the algorithm represented by this instance. - --or- - -The base-64 decoded contents of the PEM text from represent the key in a format that is not supported. - --or- - -The algorithm-specific key import failed. + +The password is incorrect. + +-or- + +The base-64 decoded contents of the PEM text from do not represent an ASN.1-BER-encoded PKCS#8 EncryptedPrivateKeyInfo structure. + +-or- + +The base-64 decoded contents of the PEM text from indicate the key is for an algorithm other than the algorithm represented by this instance. + +-or- + +The base-64 decoded contents of the PEM text from represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. @@ -1672,33 +1672,33 @@ The algorithm-specific key import failed. The PEM text of the key to import. Imports an RFC 7468 PEM-encoded key, replacing the keys for this object. - - does not contain a PEM-encoded key with a recognized label. - --or- - - contains multiple PEM-encoded keys with a recognized label. - --or- - - contains an encrypted PEM-encoded key. + does not contain a PEM-encoded key with a recognized label. + +-or- + + contains multiple PEM-encoded keys with a recognized label. + +-or- + + contains an encrypted PEM-encoded key. @@ -1790,26 +1790,26 @@ The algorithm-specific key import failed. When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. Imports the public/private keypair from a PKCS#8 PrivateKeyInfo structure after decryption, replacing the keys for this object. - - The contents of do not represent an ASN.1-BER-encoded PKCS#8 PrivateKeyInfo structure. - --or- - -The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. - --or- - -The contents of represent the key in a format that is not supported. - --or- - -The algorithm-specific key import failed. + The contents of do not represent an ASN.1-BER-encoded PKCS#8 PrivateKeyInfo structure. + +-or- + +The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. + +-or- + +The contents of represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. @@ -1851,18 +1851,18 @@ The algorithm-specific key import failed. When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. Imports the public/private keypair from a PKCS#1 RSAPrivateKey structure after decryption, replacing the keys for this object. - - The contents of do not represent an ASN.1-BER-encoded PKCS#1 RSAPrivateKey structure. - --or- - -The key import failed. + The contents of do not represent an ASN.1-BER-encoded PKCS#1 RSAPrivateKey structure. + +-or- + +The key import failed. @@ -1904,18 +1904,18 @@ The key import failed. When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. Imports the public key from a PKCS#1 RSAPublicKey structure after decryption, replacing the keys for this object. - - The contents of do not represent an ASN.1-BER-encoded PKCS#1 RSAPublicKey structure. - --or- - -The key import failed. + The contents of do not represent an ASN.1-BER-encoded PKCS#1 RSAPublicKey structure. + +-or- + +The key import failed. @@ -1956,26 +1956,26 @@ The key import failed. When this method returns, contains a value that indicates the number of bytes read from . This parameter is treated as uninitialized. Imports the public key from an X.509 SubjectPublicKeyInfo structure after decryption, replacing the keys for this object. - - The contents of do not represent an ASN.1-DER-encoded X.509 SubjectPublicKeyInfo structure. - --or- - -The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. - --or- - -The contents of represent the key in a format that is not supported. - --or- - -The algorithm-specific key import failed. + The contents of do not represent an ASN.1-DER-encoded X.509 SubjectPublicKeyInfo structure. + +-or- + +The contents of indicate the key is for an algorithm other than the algorithm represented by this instance. + +-or- + +The contents of represent the key in a format that is not supported. + +-or- + +The algorithm-specific key import failed. @@ -2134,22 +2134,22 @@ The algorithm-specific key import failed. The RSA signature for the specified data. To be added. - is . - - -or- - + is . + + -or- + is . . is or . - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. @@ -2207,22 +2207,22 @@ An error occurred creating the signature. The RSA signature for the specified data. To be added. - is . - - -or- - + is . + + -or- + is . . is or . - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. @@ -2276,16 +2276,16 @@ An error occurred creating the signature. 's is an empty string. - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. - This implementation has not implemented one of , , + This implementation has not implemented one of , , or . @@ -2337,23 +2337,23 @@ An error occurred creating the signature. or 's is . - 's is an empty string. - --or- - -The buffer in is too small to hold the signature. + 's is an empty string. + +-or- + +The buffer in is too small to hold the signature. - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. - This implementation has not implemented one of , , + This implementation has not implemented one of , , or . @@ -2413,32 +2413,32 @@ An error occurred creating the signature. The RSA signature for the specified data. To be added. - is . - - -or- - + is . + + -or- + is . . is or . - is less than zero. - - -or- - - is less than zero. - - -or- - + is less than zero. + + -or- + + is less than zero. + + -or- + + - 1 results in an index that is beyond the upper bound of . - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. @@ -2501,18 +2501,18 @@ An error occurred creating the signature. To be added. A derived class must override this method. - or is . + or is . . is or . - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. @@ -2566,16 +2566,16 @@ An error occurred creating the signature. 's is an empty string. - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. - This implementation has not implemented one of + This implementation has not implemented one of or . @@ -2627,23 +2627,23 @@ An error occurred creating the signature. or 's is . - 's is an empty string. - --or- - -The buffer in is too small to hold the signature. + 's is an empty string. + +-or- + +The buffer in is too small to hold the signature. - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. - This implementation has not implemented one of + This implementation has not implemented one of or . @@ -2694,41 +2694,41 @@ An error occurred creating the signature. Creates and returns an XML string containing the key of the current object. An XML string containing the key of the current object. - method creates an XML string that contains either the public and private key of the current object or contains only the public key of the current object. - - Use the method whenever you need to conveniently persist RSA key information. To initialize an object with the key in an XML string, use the method. - -> [!CAUTION] -> Persisting an XML string containing a private key to an insecure location is a security threat. The security of your application can be compromised if a malicious third party can access your private key. To safely persist a private key, use a secure key container. For more information about persisting private keys in a key container, see [How to: Store Asymmetric Keys in a Key Container](/dotnet/standard/security/how-to-store-asymmetric-keys-in-a-key-container). - - When you pass `true` to the method, the resulting XML string takes the following form: - -``` - - … - … -

…

- … - … - … - … - … - -``` - - When you pass `false` to the method, the resulting XML string takes the following form: - -``` - - … - … - -``` - + method creates an XML string that contains either the public and private key of the current object or contains only the public key of the current object. + + Use the method whenever you need to conveniently persist RSA key information. To initialize an object with the key in an XML string, use the method. + +> [!CAUTION] +> Persisting an XML string containing a private key to an insecure location is a security threat. The security of your application can be compromised if a malicious third party can access your private key. To safely persist a private key, use a secure key container. For more information about persisting private keys in a key container, see [How to: Store Asymmetric Keys in a Key Container](/dotnet/standard/security/how-to-store-asymmetric-keys-in-a-key-container). + + When you pass `true` to the method, the resulting XML string takes the following form: + +``` + + … + … +

…

+ … + … + … + … + … + +``` + + When you pass `false` to the method, the resulting XML string takes the following form: + +``` + + … + … + +``` + ]]> .NET Core and .NET 5+ only: In all cases. @@ -2786,31 +2786,31 @@ An error occurred creating the signature. if is long enough to receive the decrypted data; otherwise, . - and copies the result to `destination`. -Derived types should override this method to avoid the intermediate array creation. - -The RSA decryption algorithm will always produce an output smaller than the input, therefore this method will never return `false` when `destination.Length >= data.Length`. - + and copies the result to `destination`. +Derived types should override this method to avoid the intermediate array creation. + +The RSA decryption algorithm will always produce an output smaller than the input, therefore this method will never return `false` when `destination.Length >= data.Length`. + ]]> is . - is unknown, or not supported by this implementation. - --or- - -The length of is not equal to the number of bytes for . - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +The length of is not equal to the number of bytes for . + +-or- + +This instance represents only a public key. + +-or- + The decryption operation failed. @@ -2866,27 +2866,27 @@ The decryption operation failed. if is long enough to receive the encrypted data; otherwise, . - and copies the result to `destination`. -Derived types should override this method to avoid the intermediate array creation. - -The RSA encryption algorithm will always produce an output equal to the number of bytes required for bits. - + and copies the result to `destination`. +Derived types should override this method to avoid the intermediate array creation. + +The RSA encryption algorithm will always produce an output equal to the number of bytes required for bits. + ]]> is . - is unknown, or not supported by this implementation. - --or- - -The length of is too long for the combination of and the selected padding. - --or- - + is unknown, or not supported by this implementation. + +-or- + +The length of is too long for the combination of and the selected padding. + +-or- + The encryption operation failed. @@ -2941,19 +2941,19 @@ The encryption operation failed. if is big enough to receive the output; otherwise, . - - The key could not be exported. - --or- - - indicates that should be used, which requires -based passwords. + The key could not be exported. + +-or- + + indicates that should be used, which requires -based passwords. @@ -3008,11 +3008,11 @@ The encryption operation failed. if is big enough to receive the output; otherwise, . - The key could not be exported. @@ -3141,19 +3141,19 @@ The encryption operation failed. if is big enough to receive the output; otherwise, . - The key could not be exported. @@ -3238,18 +3238,18 @@ The encryption operation failed. if is big enough to receive the output; otherwise, . - The key could not be exported. @@ -3342,12 +3342,12 @@ The encryption operation failed. if is long enough to receive the hash value; otherwise, . - and copies the result to `destination`. -Derived types should override this method to avoid the intermediate array creation. - + and copies the result to `destination`. +Derived types should override this method to avoid the intermediate array creation. + ]]> @@ -3405,21 +3405,21 @@ Derived types should override this method to avoid the intermediate array creati if is long enough to receive the RSA signature; otherwise, . - bits. - + bits. + ]]> is . . is or . - This instance represents only a public key. - --or- - + This instance represents only a public key. + +-or- + An error occurred creating the signature. @@ -3478,14 +3478,14 @@ An error occurred creating the signature. if is long enough to receive the RSA signature; otherwise, . - and copies the result to `destination`. -Derived types should override this method to avoid the intermediate array creation. - -The RSA signature algorithm will always produce an output equal to the number of bytes required for bits. - + and copies the result to `destination`. +Derived types should override this method to avoid the intermediate array creation. + +The RSA signature algorithm will always produce an output equal to the number of bytes required for bits. + ]]> @@ -3493,14 +3493,14 @@ The RSA signature algorithm will always produce an output equal to the number of . is or . - is unknown, or not supported by this implementation. - --or- - -This instance represents only a public key. - --or- - + is unknown, or not supported by this implementation. + +-or- + +This instance represents only a public key. + +-or- + An error occurred creating the signature. @@ -3573,14 +3573,14 @@ An error occurred creating the signature. if the signature is valid; otherwise, . To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . . is or . @@ -3643,14 +3643,14 @@ An error occurred creating the signature. if the signature is valid; otherwise, . To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . . is or . @@ -3774,26 +3774,26 @@ An error occurred creating the signature. if the signature is valid; otherwise, . To be added. - is . - - -or- - - is . - - -or- - + is . + + -or- + + is . + + -or- + is . . is or . - is less than zero. - - -or- - - is less than zero. - - -or- - + is less than zero. + + -or- + + is less than zero. + + -or- + + - 1 results in an index that is beyond the upper bound of . is unknown, or not supported by this implementation. @@ -3917,12 +3917,12 @@ An error occurred creating the signature. if the signature is valid; otherwise, . - . -Derived types should override this method to avoid the intermediate array creation. - + . +Derived types should override this method to avoid the intermediate array creation. + ]]> diff --git a/xml/System.Security.Cryptography/RSAOpenSsl.xml b/xml/System.Security.Cryptography/RSAOpenSsl.xml index cc59700c121..faa3bdd2e16 100644 --- a/xml/System.Security.Cryptography/RSAOpenSsl.xml +++ b/xml/System.Security.Cryptography/RSAOpenSsl.xml @@ -769,7 +769,7 @@ Setting this property to a new legal value discards the current key, but defers The RSA signature for the specified hash value. To be added. - or is . + or is . . is or . diff --git a/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml b/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml index 007b2817c69..3e89eeceacf 100644 --- a/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml +++ b/xml/System.Security.Cryptography/Rfc2898DeriveBytes.xml @@ -561,8 +561,6 @@ For more information about PBKDF2, see [RFC 2898](https://www.rfc-editor.org/inf The hash algorithm to use to derive the key. Initializes a new instance of the class using the specified password, salt, number of iterations and the hash algorithm name to derive the key. To be added. - - is less than zero. The property of is either or . Hash algorithm name is invalid. diff --git a/xml/System.Security.Permissions/FileDialogPermission.xml b/xml/System.Security.Permissions/FileDialogPermission.xml index 863d5f987be..f818772f2cf 100644 --- a/xml/System.Security.Permissions/FileDialogPermission.xml +++ b/xml/System.Security.Permissions/FileDialogPermission.xml @@ -53,14 +53,14 @@ Controls the ability to access files or folders through a **File** dialog box. This class cannot be inherited. - is not granted. - + This permission is typically used to provide limited access to user-specified files when is not granted. + ]]> @@ -146,11 +146,11 @@ One of the values ( or ). Initializes a new instance of the class with either restricted or unrestricted permission, as specified. - The parameter is not a valid value of . @@ -189,7 +189,7 @@ Gets or sets the permitted access to files. The permitted access to files. To be added. - An attempt is made to set the parameter to a value that is not a valid combination of the values. + An attempt is made to set a value that is not a valid combination of the values. @@ -226,11 +226,11 @@ Creates and returns an identical copy of the current permission. A copy of the current permission. - @@ -272,10 +272,10 @@ Reconstructs a permission with a specified state from an XML encoding. To be added. The parameter is . - The parameter is not a valid permission element. - - -or- - + The parameter is not a valid permission element. + + -or- + The version number of the parameter is not supported. @@ -316,11 +316,11 @@ Creates and returns a permission that is the intersection of the current permission and the specified permission. A new permission that represents the intersection of the current permission and the specified permission. This new permission is if the intersection is empty. - The parameter is not and is not of the same type as the current permission. @@ -364,11 +364,11 @@ if the current permission is a subset of the specified permission; otherwise, . - access is a subset of a permission for access. - + access is a subset of a permission for access. + ]]> The parameter is not and is not of the same type as the current permission. @@ -412,11 +412,11 @@ if the current permission is unrestricted; otherwise, . - @@ -446,7 +446,7 @@ [!NOTE] > This override of the method is not implemented in the .NET Framework version 2.0 and later. @@ -528,11 +528,11 @@ Creates a permission that is the union of the current permission and the specified permission. A new permission that represents the union of the current permission and the specified permission. - is a permission that represents all operations represented by both the current permission and the specified permission. Any demand that passes either permission passes their union. - + is a permission that represents all operations represented by both the current permission and the specified permission. Any demand that passes either permission passes their union. + ]]> The parameter is not and is not of the same type as the current permission. diff --git a/xml/System.Security.Policy/ApplicationTrustCollection.xml b/xml/System.Security.Policy/ApplicationTrustCollection.xml index 7d3854e98c8..ef1fb0114e3 100644 --- a/xml/System.Security.Policy/ApplicationTrustCollection.xml +++ b/xml/System.Security.Policy/ApplicationTrustCollection.xml @@ -50,11 +50,11 @@ Represents a collection of objects. This class cannot be inherited. - objects encapsulate security decisions about an application. - + objects encapsulate security decisions about an application. + ]]> @@ -101,11 +101,11 @@ Adds an element to the collection. The index at which the new element was inserted. - object is added to the end of the collection. To remove an application trust that you previously added, use the method. - + object is added to the end of the collection. To remove an application trust that you previously added, use the method. + ]]> @@ -164,18 +164,18 @@ An array of type containing the objects to add to the collection. Copies the elements of the specified array to the end of the collection. - objects contained in the `trusts` array are appended to the end of the collection. - - To remove a range of application trusts that you previously added, use the method. - + objects contained in the `trusts` array are appended to the end of the collection. + + To remove a range of application trusts that you previously added, use the method. + ]]> is . - The property of an specified in is . + The property of an specified in is . @@ -219,20 +219,20 @@ A containing the objects to add to the collection. Copies the elements of the specified to the end of the collection. - objects contained in `trusts` are appended to the end of the collection. - - You can use the method to quickly add another collection of application trust objects to the collection instead of manually adding each application trust to the collection using the method. - - To remove a range of application trusts that you previously added, use the method. - + objects contained in `trusts` are appended to the end of the collection. + + You can use the method to quickly add another collection of application trust objects to the collection instead of manually adding each application trust to the collection using the method. + + To remove a range of application trusts that you previously added, use the method. + ]]> is . - The property of an specified in is . + The property of an specified in is . @@ -273,11 +273,11 @@ Removes all the application trusts from the collection. - in the collection is identified by its property. If the value of the property for any object in the collection is `null`, an is thrown. - + in the collection is identified by its property. If the value of the property for any object in the collection is `null`, an is thrown. + ]]> The property of an item in the collection is . @@ -320,13 +320,13 @@ The zero-based index in at which copying begins. Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - [!CAUTION] -> All the application trusts in the collection are copied into the array starting at the specified index location, overwriting any existing data within the range of objects copied into the array. - +> All the application trusts in the collection are copied into the array starting at the specified index location, overwriting any existing data within the range of objects copied into the array. + ]]> @@ -334,10 +334,10 @@ is less than the lower bound of . - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of elements in the is greater than the available space from to the end of the destination . @@ -428,11 +428,11 @@ Gets the application trusts in the collection that match the specified application identity. An containing all matching objects. - @@ -470,20 +470,20 @@ Returns an object that can be used to iterate over the collection. An that can be used to iterate over the collection. - implements the interface that allows you to move within a collection. - - Use the property to get the item currently pointed to in the collection. - - Use the method to move to the next item in the collection. - - Use the method to move the enumerator to its initial position. - + implements the interface that allows you to move within a collection. + + Use the property to get the item currently pointed to in the collection. + + Use the method to move to the next item in the collection. + + Use the method to move the enumerator to its initial position. + > [!NOTE] -> After you create the enumerator, or use the method to reposition the enumerator to the start of the collection, you must then call the method to position the enumerator to the first item. Otherwise, the item represented by the property is undefined. - +> After you create the enumerator, or use the method to reposition the enumerator to the start of the collection, you must then call the method to position the enumerator to the first item. Otherwise, the item represented by the property is undefined. + ]]> @@ -584,11 +584,11 @@ Gets the object located at the specified index in the collection. The object at the specified index in the collection. - object from the at the specified index. - + object from the at the specified index. + ]]> @@ -639,11 +639,11 @@ Gets the object for the specified application. The object for the specified application, or if the object cannot be found. - property of each object in the collection is examined for a property value that matches the application specified by the `appFullName` parameter. - + property of each object in the collection is examined for a property value that matches the application specified by the `appFullName` parameter. + ]]> @@ -699,13 +699,13 @@ The object to remove. Removes the specified application trust from the collection. - @@ -756,13 +756,13 @@ One of the values. Removes all application trust objects that match the specified criteria from the collection. - method is used to locate all matching application trusts, and the matching items are removed from the collection. - - The objects that follow the removed objects move up to occupy the vacated positions. The indexes of the objects that are moved are also updated. - + method is used to locate all matching application trusts, and the matching items are removed from the collection. + + The objects that follow the removed objects move up to occupy the vacated positions. The indexes of the objects that are moved are also updated. + ]]> @@ -818,11 +818,11 @@ A one-dimensional array of type that contains items to be removed from the current collection. Removes the application trust objects in the specified array from the collection. - @@ -870,11 +870,11 @@ An that contains items to be removed from the current collection. Removes the application trust objects in the specified collection from the collection. - @@ -922,11 +922,11 @@ Gets an object that can be used to synchronize access to the collection. The object to use to synchronize access to the collection. - @@ -982,10 +982,10 @@ is less than zero. - is multidimensional. - - -or- - + is multidimensional. + + -or- + The number of elements in the source is greater than the available space from to the end of the destination . diff --git a/xml/System.Security.RightsManagement/CryptoProvider.xml b/xml/System.Security.RightsManagement/CryptoProvider.xml index a663e1e88e3..92de75adf0b 100644 --- a/xml/System.Security.RightsManagement/CryptoProvider.xml +++ b/xml/System.Security.RightsManagement/CryptoProvider.xml @@ -306,7 +306,7 @@ ]]> - is null. + is null. Decryption right not granted.