review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.AspNetCore.DataProtection.Extensions</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="M:Microsoft.AspNetCore.DataProtection.BitHelpers.ReadUInt64(System.Byte[],System.Int32)">\r
   8             <summary>\r
   9             Reads an unsigned 64-bit integer from <paramref name="buffer"/>\r
  10             starting at offset <paramref name="offset"/>. Data is read big-endian.\r
  11             </summary>\r
  12         </member>\r
  13         <member name="M:Microsoft.AspNetCore.DataProtection.BitHelpers.WriteUInt64(System.Byte[],System.Int32,System.UInt64)">\r
  14             <summary>\r
  15             Writes an unsigned 64-bit integer to <paramref name="buffer"/> starting at\r
  16             offset <paramref name="offset"/>. Data is written big-endian.\r
  17             </summary>\r
  18         </member>\r
  19         <member name="T:Microsoft.AspNetCore.DataProtection.DataProtectionAdvancedExtensions">\r
  20             <summary>\r
  21             Helpful extension methods for data protection APIs.\r
  22             </summary>\r
  23         </member>\r
  24         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionAdvancedExtensions.Protect(Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector,System.Byte[],System.TimeSpan)">\r
  25             <summary>\r
  26             Cryptographically protects a piece of plaintext data, expiring the data after\r
  27             the specified amount of time has elapsed.\r
  28             </summary>\r
  29             <param name="protector">The protector to use.</param>\r
  30             <param name="plaintext">The plaintext data to protect.</param>\r
  31             <param name="lifetime">The amount of time after which the payload should no longer be unprotectable.</param>\r
  32             <returns>The protected form of the plaintext data.</returns>\r
  33         </member>\r
  34         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionAdvancedExtensions.Protect(Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector,System.String,System.DateTimeOffset)">\r
  35             <summary>\r
  36             Cryptographically protects a piece of plaintext data, expiring the data at\r
  37             the chosen time.\r
  38             </summary>\r
  39             <param name="protector">The protector to use.</param>\r
  40             <param name="plaintext">The plaintext data to protect.</param>\r
  41             <param name="expiration">The time when this payload should expire.</param>\r
  42             <returns>The protected form of the plaintext data.</returns>\r
  43         </member>\r
  44         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionAdvancedExtensions.Protect(Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector,System.String,System.TimeSpan)">\r
  45             <summary>\r
  46             Cryptographically protects a piece of plaintext data, expiring the data after\r
  47             the specified amount of time has elapsed.\r
  48             </summary>\r
  49             <param name="protector">The protector to use.</param>\r
  50             <param name="plaintext">The plaintext data to protect.</param>\r
  51             <param name="lifetime">The amount of time after which the payload should no longer be unprotectable.</param>\r
  52             <returns>The protected form of the plaintext data.</returns>\r
  53         </member>\r
  54         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionAdvancedExtensions.ToTimeLimitedDataProtector(Microsoft.AspNetCore.DataProtection.IDataProtector)">\r
  55             <summary>\r
  56             Converts an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> into an <see cref="T:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector"/>\r
  57             so that payloads can be protected with a finite lifetime.\r
  58             </summary>\r
  59             <param name="protector">The <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> to convert to a time-limited protector.</param>\r
  60             <returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector"/>.</returns>\r
  61         </member>\r
  62         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionAdvancedExtensions.Unprotect(Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector,System.String,System.DateTimeOffset@)">\r
  63             <summary>\r
  64             Cryptographically unprotects a piece of protected data.\r
  65             </summary>\r
  66             <param name="protector">The protector to use.</param>\r
  67             <param name="protectedData">The protected data to unprotect.</param>\r
  68             <param name="expiration">An 'out' parameter which upon a successful unprotect\r
  69             operation receives the expiration date of the payload.</param>\r
  70             <returns>The plaintext form of the protected data.</returns>\r
  71             <exception cref="T:System.Security.Cryptography.CryptographicException">\r
  72             Thrown if <paramref name="protectedData"/> is invalid, malformed, or expired.\r
  73             </exception>\r
  74         </member>\r
  75         <member name="T:Microsoft.AspNetCore.DataProtection.DataProtectionProvider">\r
  76             <summary>\r
  77             Contains factory methods for creating an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/> where keys are stored\r
  78             at a particular location on the file system.\r
  79             </summary>\r
  80             <remarks>Use these methods when not using dependency injection to provide the service to the application.</remarks>\r
  81         </member>\r
  82         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionProvider.Create(System.String)">\r
  83             <summary>\r
  84             Creates a <see cref="T:Microsoft.AspNetCore.DataProtection.DataProtectionProvider"/> that store keys in a location based on\r
  85             the platform and operating system.\r
  86             </summary>\r
  87             <param name="applicationName">An identifier that uniquely discriminates this application from all other\r
  88             applications on the machine.</param>\r
  89         </member>\r
  90         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionProvider.Create(System.IO.DirectoryInfo)">\r
  91             <summary>\r
  92             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.DataProtectionProvider"/> given a location at which to store keys.\r
  93             </summary>\r
  94             <param name="keyDirectory">The <see cref="T:System.IO.DirectoryInfo"/> in which keys should be stored. This may\r
  95             represent a directory on a local disk or a UNC share.</param>\r
  96         </member>\r
  97         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionProvider.Create(System.IO.DirectoryInfo,System.Action{Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder})">\r
  98             <summary>\r
  99             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.DataProtectionProvider"/> given a location at which to store keys and an\r
 100             optional configuration callback.\r
 101             </summary>\r
 102             <param name="keyDirectory">The <see cref="T:System.IO.DirectoryInfo"/> in which keys should be stored. This may\r
 103             represent a directory on a local disk or a UNC share.</param>\r
 104             <param name="setupAction">An optional callback which provides further configuration of the data protection\r
 105             system. See <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder"/> for more information.</param>\r
 106         </member>\r
 107         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionProvider.Create(System.String,System.Security.Cryptography.X509Certificates.X509Certificate2)">\r
 108             <summary>\r
 109             Creates a <see cref="T:Microsoft.AspNetCore.DataProtection.DataProtectionProvider"/> that store keys in a location based on\r
 110             the platform and operating system and uses the given <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to encrypt the keys.\r
 111             </summary>\r
 112             <param name="applicationName">An identifier that uniquely discriminates this application from all other\r
 113             applications on the machine.</param>\r
 114             <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to be used for encryption.</param>\r
 115         </member>\r
 116         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionProvider.Create(System.IO.DirectoryInfo,System.Security.Cryptography.X509Certificates.X509Certificate2)">\r
 117             <summary>\r
 118             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.DataProtectionProvider"/> given a location at which to store keys\r
 119             and a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> used to encrypt the keys.\r
 120             </summary>\r
 121             <param name="keyDirectory">The <see cref="T:System.IO.DirectoryInfo"/> in which keys should be stored. This may\r
 122             represent a directory on a local disk or a UNC share.</param>\r
 123             <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to be used for encryption.</param>\r
 124         </member>\r
 125         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionProvider.Create(System.IO.DirectoryInfo,System.Action{Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder},System.Security.Cryptography.X509Certificates.X509Certificate2)">\r
 126             <summary>\r
 127             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.DataProtectionProvider"/> given a location at which to store keys, an\r
 128             optional configuration callback and a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> used to encrypt the keys.\r
 129             </summary>\r
 130             <param name="keyDirectory">The <see cref="T:System.IO.DirectoryInfo"/> in which keys should be stored. This may\r
 131             represent a directory on a local disk or a UNC share.</param>\r
 132             <param name="setupAction">An optional callback which provides further configuration of the data protection\r
 133             system. See <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder"/> for more information.</param>\r
 134             <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to be used for encryption.</param>\r
 135         </member>\r
 136         <member name="T:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector">\r
 137             <summary>\r
 138             An interface that can provide data protection services where payloads have\r
 139             a finite lifetime.\r
 140             </summary>\r
 141             <remarks>\r
 142             It is intended that payload lifetimes be somewhat short. Payloads protected\r
 143             via this mechanism are not intended for long-term persistence (e.g., longer\r
 144             than a few weeks).\r
 145             </remarks>\r
 146         </member>\r
 147         <member name="M:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector.CreateProtector(System.String)">\r
 148             <summary>\r
 149             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector"/> given a purpose.\r
 150             </summary>\r
 151             <param name="purpose">\r
 152             The purpose to be assigned to the newly-created <see cref="T:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector"/>.\r
 153             </param>\r
 154             <returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector"/> tied to the provided purpose.</returns>\r
 155             <remarks>\r
 156             The <paramref name="purpose"/> parameter must be unique for the intended use case; two\r
 157             different <see cref="T:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector"/> instances created with two different <paramref name="purpose"/>\r
 158             values will not be able to decipher each other's payloads. The <paramref name="purpose"/> parameter\r
 159             value is not intended to be kept secret.\r
 160             </remarks>\r
 161         </member>\r
 162         <member name="M:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector.Protect(System.Byte[],System.DateTimeOffset)">\r
 163             <summary>\r
 164             Cryptographically protects a piece of plaintext data, expiring the data at\r
 165             the chosen time.\r
 166             </summary>\r
 167             <param name="plaintext">The plaintext data to protect.</param>\r
 168             <param name="expiration">The time when this payload should expire.</param>\r
 169             <returns>The protected form of the plaintext data.</returns>\r
 170         </member>\r
 171         <member name="M:Microsoft.AspNetCore.DataProtection.ITimeLimitedDataProtector.Unprotect(System.Byte[],System.DateTimeOffset@)">\r
 172             <summary>\r
 173             Cryptographically unprotects a piece of protected data.\r
 174             </summary>\r
 175             <param name="protectedData">The protected data to unprotect.</param>\r
 176             <param name="expiration">An 'out' parameter which upon a successful unprotect\r
 177             operation receives the expiration date of the payload.</param>\r
 178             <returns>The plaintext form of the protected data.</returns>\r
 179             <exception cref="T:System.Security.Cryptography.CryptographicException">\r
 180             Thrown if <paramref name="protectedData"/> is invalid, malformed, or expired.\r
 181             </exception>\r
 182         </member>\r
 183         <member name="T:Microsoft.AspNetCore.DataProtection.TimeLimitedDataProtector">\r
 184             <summary>\r
 185             Wraps an existing <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> and appends a purpose that allows\r
 186             protecting data with a finite lifetime.\r
 187             </summary>\r
 188         </member>\r
 189         <member name="M:Microsoft.AspNetCore.DataProtection.ExceptionExtensions.RequiresHomogenization(System.Exception)">\r
 190             <summary>\r
 191             Determines whether an exception must be homogenized by being wrapped inside a\r
 192             CryptographicException before being rethrown.\r
 193             </summary>\r
 194         </member>\r
 195         <member name="P:Microsoft.AspNetCore.DataProtection.Extensions.Resources.CryptCommon_GenericError">\r
 196             <summary>An error occurred during a cryptographic operation.</summary>\r
 197         </member>\r
 198         <member name="P:Microsoft.AspNetCore.DataProtection.Extensions.Resources.TimeLimitedDataProtector_PayloadExpired">\r
 199             <summary>The payload expired at {0}.</summary>\r
 200         </member>\r
 201         <member name="M:Microsoft.AspNetCore.DataProtection.Extensions.Resources.FormatTimeLimitedDataProtector_PayloadExpired(System.Object)">\r
 202             <summary>The payload expired at {0}.</summary>\r
 203         </member>\r
 204         <member name="P:Microsoft.AspNetCore.DataProtection.Extensions.Resources.TimeLimitedDataProtector_PayloadInvalid">\r
 205             <summary>The payload is invalid.</summary>\r
 206         </member>\r
 207     </members>\r
 208 </doc>\r