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.Abstractions</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions">\r
   8             <summary>\r
   9             Helpful extension methods for data protection APIs.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.CreateProtector(Microsoft.AspNetCore.DataProtection.IDataProtectionProvider,System.Collections.Generic.IEnumerable{System.String})">\r
  13             <summary>\r
  14             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> given a list of purposes.\r
  15             </summary>\r
  16             <param name="provider">The <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/> from which to generate the purpose chain.</param>\r
  17             <param name="purposes">The list of purposes which contribute to the purpose chain. This list must\r
  18             contain at least one element, and it may not contain null elements.</param>\r
  19             <returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> tied to the provided purpose chain.</returns>\r
  20             <remarks>\r
  21             This is a convenience method which chains together several calls to\r
  22             <see cref="M:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider.CreateProtector(System.String)"/>. See that method's\r
  23             documentation for more information.\r
  24             </remarks>\r
  25         </member>\r
  26         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.CreateProtector(Microsoft.AspNetCore.DataProtection.IDataProtectionProvider,System.String,System.String[])">\r
  27             <summary>\r
  28             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> given a list of purposes.\r
  29             </summary>\r
  30             <param name="provider">The <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/> from which to generate the purpose chain.</param>\r
  31             <param name="purpose">The primary purpose used to create the <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/>.</param>\r
  32             <param name="subPurposes">An optional list of secondary purposes which contribute to the purpose chain.\r
  33             If this list is provided it cannot contain null elements.</param>\r
  34             <returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> tied to the provided purpose chain.</returns>\r
  35             <remarks>\r
  36             This is a convenience method which chains together several calls to\r
  37             <see cref="M:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider.CreateProtector(System.String)"/>. See that method's\r
  38             documentation for more information.\r
  39             </remarks>\r
  40         </member>\r
  41         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.GetDataProtectionProvider(System.IServiceProvider)">\r
  42             <summary>\r
  43             Retrieves an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/> from an <see cref="T:System.IServiceProvider"/>.\r
  44             </summary>\r
  45             <param name="services">The service provider from which to retrieve the <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/>.</param>\r
  46             <returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/>. This method is guaranteed never to return null.</returns>\r
  47             <exception cref="T:System.InvalidOperationException">If no <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/> service exists in <paramref name="services"/>.</exception>\r
  48         </member>\r
  49         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.GetDataProtector(System.IServiceProvider,System.Collections.Generic.IEnumerable{System.String})">\r
  50             <summary>\r
  51             Retrieves an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> from an <see cref="T:System.IServiceProvider"/> given a list of purposes.\r
  52             </summary>\r
  53             <param name="services">An <see cref="T:System.IServiceProvider"/> which contains the <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/>\r
  54             from which to generate the purpose chain.</param>\r
  55             <param name="purposes">The list of purposes which contribute to the purpose chain. This list must\r
  56             contain at least one element, and it may not contain null elements.</param>\r
  57             <returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> tied to the provided purpose chain.</returns>\r
  58             <remarks>\r
  59             This is a convenience method which calls <see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.GetDataProtectionProvider(System.IServiceProvider)"/>\r
  60             then <see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.CreateProtector(Microsoft.AspNetCore.DataProtection.IDataProtectionProvider,System.Collections.Generic.IEnumerable{System.String})"/>. See those methods'\r
  61             documentation for more information.\r
  62             </remarks>\r
  63         </member>\r
  64         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.GetDataProtector(System.IServiceProvider,System.String,System.String[])">\r
  65             <summary>\r
  66             Retrieves an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> from an <see cref="T:System.IServiceProvider"/> given a list of purposes.\r
  67             </summary>\r
  68             <param name="services">An <see cref="T:System.IServiceProvider"/> which contains the <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider"/>\r
  69             from which to generate the purpose chain.</param>\r
  70             <param name="purpose">The primary purpose used to create the <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/>.</param>\r
  71             <param name="subPurposes">An optional list of secondary purposes which contribute to the purpose chain.\r
  72             If this list is provided it cannot contain null elements.</param>\r
  73             <returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> tied to the provided purpose chain.</returns>\r
  74             <remarks>\r
  75             This is a convenience method which calls <see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.GetDataProtectionProvider(System.IServiceProvider)"/>\r
  76             then <see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.CreateProtector(Microsoft.AspNetCore.DataProtection.IDataProtectionProvider,System.String,System.String[])"/>. See those methods'\r
  77             documentation for more information.\r
  78             </remarks>\r
  79         </member>\r
  80         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.Protect(Microsoft.AspNetCore.DataProtection.IDataProtector,System.String)">\r
  81             <summary>\r
  82             Cryptographically protects a piece of plaintext data.\r
  83             </summary>\r
  84             <param name="protector">The data protector to use for this operation.</param>\r
  85             <param name="plaintext">The plaintext data to protect.</param>\r
  86             <returns>The protected form of the plaintext data.</returns>\r
  87         </member>\r
  88         <member name="M:Microsoft.AspNetCore.DataProtection.DataProtectionCommonExtensions.Unprotect(Microsoft.AspNetCore.DataProtection.IDataProtector,System.String)">\r
  89             <summary>\r
  90             Cryptographically unprotects a piece of protected data.\r
  91             </summary>\r
  92             <param name="protector">The data protector to use for this operation.</param>\r
  93             <param name="protectedData">The protected data to unprotect.</param>\r
  94             <returns>The plaintext form of the protected data.</returns>\r
  95             <exception cref="T:System.Security.Cryptography.CryptographicException">\r
  96             Thrown if <paramref name="protectedData"/> is invalid or malformed.\r
  97             </exception>\r
  98         </member>\r
  99         <member name="T:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider">\r
 100             <summary>\r
 101             An interface that can be used to create <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> instances.\r
 102             </summary>\r
 103         </member>\r
 104         <member name="M:Microsoft.AspNetCore.DataProtection.IDataProtectionProvider.CreateProtector(System.String)">\r
 105             <summary>\r
 106             Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> given a purpose.\r
 107             </summary>\r
 108             <param name="purpose">\r
 109             The purpose to be assigned to the newly-created <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/>.\r
 110             </param>\r
 111             <returns>An IDataProtector tied to the provided purpose.</returns>\r
 112             <remarks>\r
 113             The <paramref name="purpose"/> parameter must be unique for the intended use case; two\r
 114             different <see cref="T:Microsoft.AspNetCore.DataProtection.IDataProtector"/> instances created with two different <paramref name="purpose"/>\r
 115             values will not be able to decipher each other's payloads. The <paramref name="purpose"/> parameter\r
 116             value is not intended to be kept secret.\r
 117             </remarks>\r
 118         </member>\r
 119         <member name="T:Microsoft.AspNetCore.DataProtection.IDataProtector">\r
 120             <summary>\r
 121             An interface that can provide data protection services.\r
 122             </summary>\r
 123         </member>\r
 124         <member name="M:Microsoft.AspNetCore.DataProtection.IDataProtector.Protect(System.Byte[])">\r
 125             <summary>\r
 126             Cryptographically protects a piece of plaintext data.\r
 127             </summary>\r
 128             <param name="plaintext">The plaintext data to protect.</param>\r
 129             <returns>The protected form of the plaintext data.</returns>\r
 130         </member>\r
 131         <member name="M:Microsoft.AspNetCore.DataProtection.IDataProtector.Unprotect(System.Byte[])">\r
 132             <summary>\r
 133             Cryptographically unprotects a piece of protected data.\r
 134             </summary>\r
 135             <param name="protectedData">The protected data to unprotect.</param>\r
 136             <returns>The plaintext form of the protected data.</returns>\r
 137             <exception cref="T:System.Security.Cryptography.CryptographicException">\r
 138             Thrown if the protected data is invalid or malformed.\r
 139             </exception>\r
 140         </member>\r
 141         <member name="T:Microsoft.AspNetCore.DataProtection.Infrastructure.IApplicationDiscriminator">\r
 142             <summary>\r
 143             Provides information used to discriminate applications.\r
 144             </summary>\r
 145             <remarks>\r
 146             This type supports the data protection system and is not intended to be used\r
 147             by consumers.\r
 148             </remarks>\r
 149         </member>\r
 150         <member name="P:Microsoft.AspNetCore.DataProtection.Infrastructure.IApplicationDiscriminator.Discriminator">\r
 151             <summary>\r
 152             An identifier that uniquely discriminates this application from all other\r
 153             applications on the machine.\r
 154             </summary>\r
 155         </member>\r
 156         <member name="M:Microsoft.AspNetCore.DataProtection.ExceptionExtensions.RequiresHomogenization(System.Exception)">\r
 157             <summary>\r
 158             Determines whether an exception must be homogenized by being wrapped inside a\r
 159             CryptographicException before being rethrown.\r
 160             </summary>\r
 161         </member>\r
 162         <member name="P:Microsoft.AspNetCore.DataProtection.Abstractions.Resources.CryptCommon_PayloadInvalid">\r
 163             <summary>The payload was invalid.</summary>\r
 164         </member>\r
 165         <member name="P:Microsoft.AspNetCore.DataProtection.Abstractions.Resources.DataProtectionExtensions_NullPurposesCollection">\r
 166             <summary>The purposes collection cannot be null or empty and cannot contain null elements.</summary>\r
 167         </member>\r
 168         <member name="P:Microsoft.AspNetCore.DataProtection.Abstractions.Resources.CryptCommon_GenericError">\r
 169             <summary>An error occurred during a cryptographic operation.</summary>\r
 170         </member>\r
 171         <member name="P:Microsoft.AspNetCore.DataProtection.Abstractions.Resources.DataProtectionExtensions_NoService">\r
 172             <summary>No service for type '{0}' has been registered.</summary>\r
 173         </member>\r
 174         <member name="M:Microsoft.AspNetCore.DataProtection.Abstractions.Resources.FormatDataProtectionExtensions_NoService(System.Object)">\r
 175             <summary>No service for type '{0}' has been registered.</summary>\r
 176         </member>\r
 177         <member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_InvalidCountOffsetOrLength">\r
 178             <summary>\r
 179             Invalid {0}, {1} or {2} length.\r
 180             </summary>\r
 181         </member>\r
 182         <member name="F:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.WebEncoders_MalformedInput">\r
 183             <summary>\r
 184             Malformed input: {0} is an invalid input length.\r
 185             </summary>\r
 186         </member>\r
 187         <member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_InvalidCountOffsetOrLength(System.Object,System.Object,System.Object)">\r
 188             <summary>\r
 189             Invalid {0}, {1} or {2} length.\r
 190             </summary>\r
 191         </member>\r
 192         <member name="M:Microsoft.Extensions.WebEncoders.Sources.EncoderResources.FormatWebEncoders_MalformedInput(System.Object)">\r
 193             <summary>\r
 194             Malformed input: {0} is an invalid input length.\r
 195             </summary>\r
 196         </member>\r
 197         <member name="T:Microsoft.Extensions.Internal.WebEncoders">\r
 198             <summary>\r
 199             Contains utility APIs to assist with common encoding and decoding operations.\r
 200             </summary>\r
 201         </member>\r
 202         <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String)">\r
 203             <summary>\r
 204             Decodes a base64url-encoded string.\r
 205             </summary>\r
 206             <param name="input">The base64url-encoded input to decode.</param>\r
 207             <returns>The base64url-decoded form of the input.</returns>\r
 208             <remarks>\r
 209             The input must not contain any whitespace or padding characters.\r
 210             Throws <see cref="T:System.FormatException"/> if the input is malformed.\r
 211             </remarks>\r
 212         </member>\r
 213         <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Int32)">\r
 214             <summary>\r
 215             Decodes a base64url-encoded substring of a given string.\r
 216             </summary>\r
 217             <param name="input">A string containing the base64url-encoded input to decode.</param>\r
 218             <param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>\r
 219             <param name="count">The number of characters in <paramref name="input"/> to decode.</param>\r
 220             <returns>The base64url-decoded form of the input.</returns>\r
 221             <remarks>\r
 222             The input must not contain any whitespace or padding characters.\r
 223             Throws <see cref="T:System.FormatException"/> if the input is malformed.\r
 224             </remarks>\r
 225         </member>\r
 226         <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)">\r
 227             <summary>\r
 228             Decodes a base64url-encoded <paramref name="input"/> into a <c>byte[]</c>.\r
 229             </summary>\r
 230             <param name="input">A string containing the base64url-encoded input to decode.</param>\r
 231             <param name="offset">The position in <paramref name="input"/> at which decoding should begin.</param>\r
 232             <param name="buffer">\r
 233             Scratch buffer to hold the <see cref="T:System.Char"/>s to decode. Array must be large enough to hold\r
 234             <paramref name="bufferOffset"/> and <paramref name="count"/> characters as well as Base64 padding\r
 235             characters. Content is not preserved.\r
 236             </param>\r
 237             <param name="bufferOffset">\r
 238             The offset into <paramref name="buffer"/> at which to begin writing the <see cref="T:System.Char"/>s to decode.\r
 239             </param>\r
 240             <param name="count">The number of characters in <paramref name="input"/> to decode.</param>\r
 241             <returns>The base64url-decoded form of the <paramref name="input"/>.</returns>\r
 242             <remarks>\r
 243             The input must not contain any whitespace or padding characters.\r
 244             Throws <see cref="T:System.FormatException"/> if the input is malformed.\r
 245             </remarks>\r
 246         </member>\r
 247         <member name="M:Microsoft.Extensions.Internal.WebEncoders.GetArraySizeRequiredToDecode(System.Int32)">\r
 248             <summary>\r
 249             Gets the minimum <c>char[]</c> size required for decoding of <paramref name="count"/> characters\r
 250             with the <see cref="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlDecode(System.String,System.Int32,System.Char[],System.Int32,System.Int32)"/> method.\r
 251             </summary>\r
 252             <param name="count">The number of characters to decode.</param>\r
 253             <returns>\r
 254             The minimum <c>char[]</c> size required for decoding  of <paramref name="count"/> characters.\r
 255             </returns>\r
 256         </member>\r
 257         <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[])">\r
 258             <summary>\r
 259             Encodes <paramref name="input"/> using base64url encoding.\r
 260             </summary>\r
 261             <param name="input">The binary input to encode.</param>\r
 262             <returns>The base64url-encoded form of <paramref name="input"/>.</returns>\r
 263         </member>\r
 264         <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Int32)">\r
 265             <summary>\r
 266             Encodes <paramref name="input"/> using base64url encoding.\r
 267             </summary>\r
 268             <param name="input">The binary input to encode.</param>\r
 269             <param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>\r
 270             <param name="count">The number of bytes from <paramref name="input"/> to encode.</param>\r
 271             <returns>The base64url-encoded form of <paramref name="input"/>.</returns>\r
 272         </member>\r
 273         <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)">\r
 274             <summary>\r
 275             Encodes <paramref name="input"/> using base64url encoding.\r
 276             </summary>\r
 277             <param name="input">The binary input to encode.</param>\r
 278             <param name="offset">The offset into <paramref name="input"/> at which to begin encoding.</param>\r
 279             <param name="output">\r
 280             Buffer to receive the base64url-encoded form of <paramref name="input"/>. Array must be large enough to\r
 281             hold <paramref name="outputOffset"/> characters and the full base64-encoded form of\r
 282             <paramref name="input"/>, including padding characters.\r
 283             </param>\r
 284             <param name="outputOffset">\r
 285             The offset into <paramref name="output"/> at which to begin writing the base64url-encoded form of\r
 286             <paramref name="input"/>.\r
 287             </param>\r
 288             <param name="count">The number of <c>byte</c>s from <paramref name="input"/> to encode.</param>\r
 289             <returns>\r
 290             The number of characters written to <paramref name="output"/>, less any padding characters.\r
 291             </returns>\r
 292         </member>\r
 293         <member name="M:Microsoft.Extensions.Internal.WebEncoders.GetArraySizeRequiredToEncode(System.Int32)">\r
 294             <summary>\r
 295             Get the minimum output <c>char[]</c> size required for encoding <paramref name="count"/>\r
 296             <see cref="T:System.Byte"/>s with the <see cref="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.Byte[],System.Int32,System.Char[],System.Int32,System.Int32)"/> method.\r
 297             </summary>\r
 298             <param name="count">The number of characters to encode.</param>\r
 299             <returns>\r
 300             The minimum output <c>char[]</c> size required for encoding <paramref name="count"/> <see cref="T:System.Byte"/>s.\r
 301             </returns>\r
 302         </member>\r
 303         <member name="M:Microsoft.Extensions.Internal.WebEncoders.Base64UrlEncode(System.ReadOnlySpan{System.Byte})">\r
 304             <summary>\r
 305             Encodes <paramref name="input"/> using base64url encoding.\r
 306             </summary>\r
 307             <param name="input">The binary input to encode.</param>\r
 308             <returns>The base64url-encoded form of <paramref name="input"/>.</returns>\r
 309         </member>\r
 310     </members>\r
 311 </doc>\r