Microsoft.Azure.KeyVault.WebKey.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Microsoft.Azure.KeyVault.WebKey</name> </assembly> <members> <member name="M:Microsoft.Azure.KeyVault.WebKey.Base64UrlJsonConverter.ToBase64UrlString(System.Byte[])"> <summary> Converts a byte array to a Base64Url encoded string </summary> <param name="input">The byte array to convert</param> <returns>The Base64Url encoded form of the input</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.Base64UrlJsonConverter.FromBase64UrlString(System.String)"> <summary> Converts a Base64Url encoded string to a byte array </summary> <param name="input">The Base64Url encoded string</param> <returns>The byte array represented by the enconded string</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.Base64UrlJsonConverter.Pad(System.String)"> <summary> Adds padding to the input </summary> <param name="input"> the input string </param> <returns> the padded string </returns> </member> <member name="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKey"> <summary> As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18 </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.Kid"> <summary> Key Identifier </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.Kty"> <summary> Gets or sets supported JsonWebKey key types (kty) for Elliptic Curve, RSA, HSM, Octet, usually RSA. Possible values include: 'EC', 'RSA', 'RSA-HSM', 'oct' </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.KeyOps"> <summary> Supported Key Operations </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.N"> <summary> RSA modulus, in Base64. </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.E"> <summary> RSA public exponent, in Base64. </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.D"> <summary> RSA private exponent </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.DP"> <summary> RSA Private Key Parameter </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.DQ"> <summary> RSA Private Key Parameter </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.QI"> <summary> RSA Private Key Parameter </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.P"> <summary> RSA secret prime </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.Q"> <summary> RSA secret prime, with p < q </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.K"> <summary> Symmetric key </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.T"> <summary> HSM Token, used with "Bring Your Own Key" </summary> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.#ctor"> <summary> Creates an instance of <see cref="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKey"/> </summary> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.#ctor(System.Security.Cryptography.Aes)"> <summary> Converts an AES object to a WebKey of type Octet </summary> <param name="aesProvider"></param> <returns></returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.#ctor(System.Security.Cryptography.RSA,System.Boolean)"> <summary> Converts a RSA object to a WebKey of type RSA. </summary> <param name="rsaProvider">The RSA object to convert</param> <param name="includePrivateParameters">True to include the RSA private key parameters</param> <returns>A WebKey representing the RSA object</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.#ctor(System.Security.Cryptography.RSAParameters)"> <summary> Converts a RSAParameters object to a WebKey of type RSA. </summary> <param name="rsaParameters">The RSA object to convert</param> <returns>A WebKey representing the RSA object</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.Equals(Microsoft.Azure.KeyVault.WebKey.JsonWebKey)"> <summary> Compares <see cref="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKey"/> objects </summary> <param name="other"> the <see cref="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKey"/> object to compare with </param> <returns> whether the <see cref="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKey"/> objects are equals </returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.HasPrivateKey"> <summary> Verifies whether this object has a private key </summary> <returns> True if the object has private key; false otherwise.</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.IsValid"> <summary> Determines if the WebKey object is valid according to the rules for each of the possible WebKeyTypes. For more information, see WebKeyTypes. </summary> <returns>true if the WebKey is valid</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.ToAes"> <summary> Converts a WebKey of type Octet to an AES object. </summary> <returns>An AES object</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.CanonicalizeRSA"> <summary> Remove leading zeros from all RSA parameters. </summary> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.ToRSA(System.Boolean)"> <summary> Converts a WebKey of type RSA or RSAHSM to a RSA object </summary> <param name="includePrivateParameters">Determines whether private key material, if available, is included</param> <returns>An initialized RSA instance</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.ToRSAParameters(System.Boolean)"> <summary> Converts a WebKey of type RSA or RSAHSM to a RSA parameter object </summary> <param name="includePrivateParameters">Determines whether private key material, if available, is included</param> <returns>An RSA parameter</returns> </member> <member name="M:Microsoft.Azure.KeyVault.WebKey.JsonWebKey.ClearMemory"> <summary> Best effort to clear private key material Not strong guarantee since GC may move the arrays during compact. </summary> </member> <member name="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKeyEncryptionAlgorithm"> <summary> Supported JsonWebKey algorithms </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKeyEncryptionAlgorithm.AllAlgorithms"> <summary> All algorithms names. Use clone to avoid FxCop violation </summary> </member> <member name="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKeyOperation"> <summary> Supported JsonWebKey operations </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKeyOperation.AllOperations"> <summary> All operations names. Use clone to avoid FxCop violation </summary> </member> <member name="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKeySignatureAlgorithm"> <summary> Supported JsonWebKey algorithms </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKeySignatureAlgorithm.AllAlgorithms"> <summary> All algorithms names. Use clone to avoid FxCop violation </summary> </member> <member name="T:Microsoft.Azure.KeyVault.WebKey.JsonWebKeyType"> <summary> Supported JsonWebKey key types (kty) </summary> </member> <member name="P:Microsoft.Azure.KeyVault.WebKey.JsonWebKeyType.AllTypes"> <summary> All types names. Use clone to avoid FxCop violation </summary> </member> </members> </doc> |