Microsoft.IdentityModel.JsonWebTokens.xml 80 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.IdentityModel.JsonWebTokens</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes">
  8. <summary>
  9. Constants for Json Web tokens.
  10. </summary>
  11. </member>
  12. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.Json">
  13. <summary>
  14. A URI that represents the JSON XML data type.
  15. </summary>
  16. <remarks>When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'.</remarks>
  17. </member>
  18. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.JsonArray">
  19. <summary>
  20. A URI that represents the JSON array XML data type.
  21. </summary>
  22. <remarks>When mapping json to .Net Claim(s), if the value was not a string (or an enumeration of strings), the ClaimValue will serialized using the current JSON serializer, a property will be added with the .Net type and the ClaimTypeValue will be set to 'JsonClaimValueType'.</remarks>
  23. </member>
  24. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonClaimValueTypes.JsonNull">
  25. <summary>
  26. A URI that represents the JSON null data type
  27. </summary>
  28. <remarks>When mapping json to .Net Claim(s), we use empty string to represent the claim value and set the ClaimValueType to JsonNull</remarks>
  29. </member>
  30. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken">
  31. <summary>
  32. A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> designed for representing a JSON Web Token (JWT).
  33. </summary>
  34. </member>
  35. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)">
  36. <summary>
  37. Initializes a new instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> from a string in JWS or JWE Compact serialized format.
  38. </summary>
  39. <param name="jwtEncodedString">A JSON Web Token that has been serialized in JWS or JWE Compact serialized format.</param>
  40. <exception cref="T:System.ArgumentNullException">'jwtEncodedString' is null or empty.</exception>
  41. <exception cref="T:System.ArgumentException">'jwtEncodedString' is not in JWS or JWE Compact serialization format.</exception>
  42. <remarks>
  43. The contents of the returned <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> have not been validated, the JSON Web Token is simply decoded. Validation can be accomplished using the validation methods in <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler"/>
  44. </remarks>
  45. </member>
  46. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String,System.String)">
  47. <summary>
  48. Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> class where the header contains the crypto algorithms applied to the encoded header and payload.
  49. </summary>
  50. <param name="header">A string containing JSON which represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT.</param>
  51. <param name="payload">A string containing JSON which represents the claims contained in the JWT. Each claim is a JSON object of the form { Name, Value }.</param>
  52. <exception cref="T:System.ArgumentNullException">'header' is null.</exception>
  53. <exception cref="T:System.ArgumentNullException">'payload' is null.</exception>
  54. </member>
  55. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Actor">
  56. <summary>
  57. Gets the 'value' of the 'actort' claim { actort, 'value' }.
  58. </summary>
  59. <remarks>If the 'actort' claim is not found, an empty string is returned.</remarks>
  60. </member>
  61. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Alg">
  62. <summary>
  63. Gets the 'value' of the 'alg' claim { alg, 'value' }.
  64. </summary>
  65. <remarks>If the 'alg' claim is not found, an empty string is returned.</remarks>
  66. </member>
  67. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Audiences">
  68. <summary>
  69. Gets the list of 'aud' claim { aud, 'value' }.
  70. </summary>
  71. <remarks>If the 'aud' claim is not found, enumeration will be empty.</remarks>
  72. </member>
  73. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.AuthenticationTag">
  74. <summary>
  75. Gets the AuthenticationTag from the original raw data of this instance when it was created.
  76. </summary>
  77. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  78. </member>
  79. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Ciphertext">
  80. <summary>
  81. Gets the Ciphertext from the original raw data of this instance when it was created.
  82. </summary>
  83. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  84. </member>
  85. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims">
  86. <summary>
  87. Gets a <see cref="T:System.Collections.Generic.IEnumerable`1"/><see cref="T:System.Security.Claims.Claim"/> for each JSON { name, value }.
  88. </summary>
  89. </member>
  90. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Cty">
  91. <summary>
  92. Gets the 'value' of the 'cty' claim { cty, 'value' }.
  93. </summary>
  94. <remarks>If the 'cty' claim is not found, an empty string is returned.</remarks>
  95. </member>
  96. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Enc">
  97. <summary>
  98. Gets the 'value' of the 'enc' claim { enc, 'value' }.
  99. </summary>
  100. <remarks>If the 'enc' value is not found, an empty string is returned.</remarks>
  101. </member>
  102. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncryptedKey">
  103. <summary>
  104. Gets the EncryptedKey from the original raw data of this instance when it was created.
  105. </summary>
  106. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  107. </member>
  108. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Header">
  109. <summary>
  110. Represents the cryptographic operations applied to the JWT and optionally any additional properties of the JWT.
  111. </summary>
  112. </member>
  113. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Id">
  114. <summary>
  115. Gets the 'value' of the 'jti' claim { jti, ''value' }.
  116. </summary>
  117. <remarks>If the 'jti' claim is not found, an empty string is returned.</remarks>
  118. </member>
  119. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InitializationVector">
  120. <summary>
  121. Gets the InitializationVector from the original raw data of this instance when it was created.
  122. </summary>
  123. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  124. </member>
  125. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.InnerToken">
  126. <summary>
  127. Gets the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> associated with this instance.
  128. </summary>
  129. </member>
  130. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.IssuedAt">
  131. <summary>
  132. Gets the 'value' of the 'iat' claim { iat, 'value' } converted to a <see cref="T:System.DateTime"/> assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z).
  133. </summary>
  134. <remarks>If the 'iat' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks>
  135. </member>
  136. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Issuer">
  137. <summary>
  138. Gets the 'value' of the 'iss' claim { iss, 'value' }.
  139. </summary>
  140. <remarks>If the 'iss' claim is not found, an empty string is returned.</remarks>
  141. </member>
  142. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Kid">
  143. <summary>
  144. Gets the 'value' of the 'kid' claim { kid, 'value' }.
  145. </summary>
  146. <remarks>If the 'kid' claim is not found, an empty string is returned.</remarks>
  147. </member>
  148. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Payload">
  149. <summary>
  150. Represents the JSON payload.
  151. </summary>
  152. </member>
  153. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedHeader">
  154. <summary>
  155. Gets the EncodedHeader from the original raw data of this instance when it was created.
  156. </summary>
  157. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  158. </member>
  159. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedPayload">
  160. <summary>
  161. Gets the EncodedPayload from the original raw data of this instance when it was created.
  162. </summary>
  163. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  164. </member>
  165. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedSignature">
  166. <summary>
  167. Gets the EncodedSignature from the original raw data of this instance when it was created.
  168. </summary>
  169. <remarks>The original JSON Compact serialized format passed into the constructor. <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.#ctor(System.String)"/></remarks>
  170. </member>
  171. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.EncodedToken">
  172. <summary>
  173. Gets the original raw data of this instance when it was created.
  174. </summary>
  175. </member>
  176. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SecurityKey">
  177. <summary>
  178. Not implemented.
  179. </summary>
  180. </member>
  181. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.SigningKey">
  182. <summary>
  183. Not implemented.
  184. </summary>
  185. </member>
  186. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Subject">
  187. <summary>
  188. Gets the 'value' of the 'sub' claim { sub, 'value' }.
  189. </summary>
  190. <remarks>If the 'sub' claim is not found, an empty string is returned.</remarks>
  191. </member>
  192. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Typ">
  193. <summary>
  194. Gets the 'value' of the 'typ' claim { typ, 'value' }.
  195. </summary>
  196. <remarks>If the 'typ' claim is not found, an empty string is returned.</remarks>
  197. </member>
  198. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.ValidFrom">
  199. <summary>
  200. Gets the 'value' of the 'nbf' claim { nbf, 'value' } converted to a <see cref="T:System.DateTime"/> assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z).
  201. </summary>
  202. <remarks>If the 'nbf' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks>
  203. </member>
  204. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.ValidTo">
  205. <summary>
  206. Gets the 'value' of the 'exp' claim { exp, 'value' } converted to a <see cref="T:System.DateTime"/> assuming 'value' is seconds since UnixEpoch (UTC 1970-01-01T0:0:0Z).
  207. </summary>
  208. <remarks>If the 'exp' claim is not found, then <see cref="F:System.DateTime.MinValue"/> is returned.</remarks>
  209. </member>
  210. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.X5t">
  211. <summary>
  212. Gets the 'value' of the 'x5t' claim { x5t, 'value' }.
  213. </summary>
  214. <remarks>If the 'x5t' claim is not found, an empty string is returned.</remarks>
  215. </member>
  216. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Zip">
  217. <summary>
  218. Gets the 'value' of the 'zip' claim { zip, 'value' }.
  219. </summary>
  220. <remarks>If the 'zip' claim is not found, an empty string is returned.</remarks>
  221. </member>
  222. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Decode(System.String[],System.String)">
  223. <summary>
  224. Decodes the string into the header, payload and signature.
  225. </summary>
  226. <param name="tokenParts">the tokenized string.</param>
  227. <param name="rawData">the original token.</param>
  228. </member>
  229. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.DecodeJwe(System.String[])">
  230. <summary>
  231. Decodes the payload and signature from the JWE parts.
  232. </summary>
  233. <param name="tokenParts">Parts of the JWE including the header.</param>
  234. <remarks>
  235. Assumes Header has already been set.
  236. According to the JWE documentation (https://datatracker.ietf.org/doc/html/rfc7516#section-2), it is possible for the EncryptedKey, InitializationVector, and AuthenticationTag to be empty strings.
  237. </remarks>
  238. </member>
  239. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.DecodeJws(System.String[])">
  240. <summary>
  241. Decodes the payload and signature from the JWS parts.
  242. </summary>
  243. <param name="tokenParts">Parts of the JWS including the header.</param>
  244. <remarks>Assumes Header has already been set.</remarks>
  245. </member>
  246. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetClaim(System.String)">
  247. <summary>
  248. Gets a <see cref="T:System.Security.Claims.Claim"/> representing the { key, 'value' } pair corresponding to the provided <paramref name="key"/>.
  249. </summary>
  250. <remarks>If the key has no corresponding value, this method will throw.</remarks>
  251. </member>
  252. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetPayloadValue``1(System.String)">
  253. <summary>
  254. Gets the 'value' corresponding to the provided key from the JWT payload { key, 'value' }.
  255. </summary>
  256. <remarks>If the key has no corresponding value, this method will throw. </remarks>
  257. </member>
  258. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetClaim(System.String,System.Security.Claims.Claim@)">
  259. <summary>
  260. Tries to get the <see cref="T:System.Security.Claims.Claim"/> representing the { key, 'value' } pair corresponding to the provided <paramref name="key"/>.
  261. </summary>
  262. <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks>
  263. </member>
  264. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetPayloadValue``1(System.String,``0@)">
  265. <summary>
  266. Tries to get the 'value' corresponding to the provided key from the JWT payload { key, 'value' }.
  267. </summary>
  268. <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks>
  269. </member>
  270. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.GetHeaderValue``1(System.String)">
  271. <summary>
  272. Gets the 'value' corresponding to the provided key from the JWT header { key, 'value' }.
  273. </summary>
  274. <remarks>If the key has no corresponding value, this method will throw. </remarks>
  275. </member>
  276. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.TryGetHeaderValue``1(System.String,``0@)">
  277. <summary>
  278. Tries to get the value corresponding to the provided key from the JWT header { key, 'value' }.
  279. </summary>
  280. <remarks>If the key has no corresponding value, returns false. Otherwise returns true. </remarks>
  281. </member>
  282. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler">
  283. <summary>
  284. A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> designed for creating and validating Json Web Tokens.
  285. See: https://datatracker.ietf.org/doc/html/rfc7519 and http://www.rfc-editor.org/info/rfc7515.
  286. </summary>
  287. </member>
  288. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.Base64UrlEncodedUnsignedJWSHeader">
  289. <summary>
  290. Gets the Base64Url encoded string representation of the following JWT header:
  291. { <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg"/>, <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.None"/> }.
  292. </summary>
  293. <return>The Base64Url encoded string representation of the unsigned JWT header.</return>
  294. </member>
  295. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.TokenType">
  296. <summary>
  297. Gets the type of the <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  298. </summary>
  299. <return>The type of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></return>
  300. </member>
  301. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanReadToken(System.String)">
  302. <summary>
  303. Determines if the string is a well formed Json Web Token (JWT).
  304. <para>See: https://datatracker.ietf.org/doc/html/rfc7519 </para>
  305. </summary>
  306. <param name="token">String that should represent a valid JWT.</param>
  307. <remarks>Uses <see cref="M:System.Text.RegularExpressions.Regex.IsMatch(System.String,System.String)"/> matching:
  308. <para>JWS: @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"</para>
  309. <para>JWE: (dir): @"^[A-Za-z0-9-_]+\.\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]*$"</para>
  310. <para>JWE: (wrappedkey): @"^[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]+\.[A-Za-z0-9-_]$"</para>
  311. </remarks>
  312. <returns>
  313. <para>'false' if the token is null or whitespace.</para>
  314. <para>'false' if token.Length is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</para>
  315. <para>'true' if the token is in JSON compact serialization format.</para>
  316. </returns>
  317. </member>
  318. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CanValidateToken">
  319. <summary>
  320. Returns a value that indicates if this handler can validate a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
  321. </summary>
  322. <returns>'true', indicating this instance can validate a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.</returns>
  323. </member>
  324. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String)">
  325. <summary>
  326. Creates an unsigned JWS (Json Web Signature).
  327. </summary>
  328. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  329. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  330. <returns>A JWS in Compact Serialization Format.</returns>
  331. </member>
  332. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  333. <summary>
  334. Creates an unsigned JWS (Json Web Signature).
  335. </summary>
  336. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  337. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the JWT token header.</param>
  338. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  339. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception>
  340. <returns>A JWS in Compact Serialization Format.</returns>
  341. </member>
  342. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials)">
  343. <summary>
  344. Creates a JWS (Json Web Signature).
  345. </summary>
  346. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  347. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWS.</param>
  348. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  349. <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception>
  350. <returns>A JWS in Compact Serialization Format.</returns>
  351. </member>
  352. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})">
  353. <summary>
  354. Creates a JWS (Json Web Signature).
  355. </summary>
  356. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  357. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWS.</param>
  358. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the JWT token header.</param>
  359. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  360. <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception>
  361. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception>
  362. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid"/>
  363. <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc"/>, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip"/>
  364. are present inside of <paramref name="additionalHeaderClaims"/>.</exception>
  365. <returns>A JWS in Compact Serialization Format.</returns>
  366. </member>
  367. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)">
  368. <summary>
  369. Creates a JWS(Json Web Signature).
  370. </summary>
  371. <param name="tokenDescriptor">A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"/> that contains details of contents of the token.</param>
  372. <returns>A JWS in Compact Serialization Format.</returns>
  373. </member>
  374. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials)">
  375. <summary>
  376. Creates a JWE (Json Web Encryption).
  377. </summary>
  378. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  379. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  380. <returns>A JWE in compact serialization format.</returns>
  381. </member>
  382. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})">
  383. <summary>
  384. Creates a JWE (Json Web Encryption).
  385. </summary>
  386. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  387. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  388. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
  389. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  390. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  391. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception>
  392. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid"/>
  393. <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc"/>, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip"/>
  394. are present inside of <paramref name="additionalHeaderClaims"/>.</exception>
  395. <returns>A JWS in Compact Serialization Format.</returns>
  396. </member>
  397. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials)">
  398. <summary>
  399. Creates a JWE (Json Web Encryption).
  400. </summary>
  401. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  402. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
  403. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  404. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  405. <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception>
  406. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  407. <returns>A JWE in compact serialization format.</returns>
  408. </member>
  409. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})">
  410. <summary>
  411. Creates a JWE (Json Web Encryption).
  412. </summary>
  413. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  414. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
  415. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  416. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
  417. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  418. <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception>
  419. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  420. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception>
  421. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid"/>
  422. <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc"/>, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip"/>
  423. are present inside of <paramref name="additionalHeaderClaims"/>.</exception>
  424. <returns>A JWE in compact serialization format.</returns>
  425. </member>
  426. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)">
  427. <summary>
  428. Creates a JWE (Json Web Encryption).
  429. </summary>
  430. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  431. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  432. <param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
  433. <returns>A JWE in compact serialization format.</returns>
  434. </member>
  435. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)">
  436. <summary>
  437. Creates a JWE (Json Web Encryption).
  438. </summary>
  439. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  440. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
  441. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  442. <param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
  443. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  444. <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception>
  445. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  446. <exception cref="T:System.ArgumentNullException">if <paramref name="compressionAlgorithm"/> is null.</exception>
  447. <returns>A JWE in compact serialization format.</returns>
  448. </member>
  449. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String,System.Collections.Generic.IDictionary{System.String,System.Object},System.Collections.Generic.IDictionary{System.String,System.Object})">
  450. <summary>
  451. Creates a JWE (Json Web Encryption).
  452. </summary>
  453. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  454. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
  455. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  456. <param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
  457. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
  458. <param name="additionalInnerHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the inner JWT token header.</param>
  459. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  460. <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception>
  461. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  462. <exception cref="T:System.ArgumentNullException">if <paramref name="compressionAlgorithm"/> is null.</exception>
  463. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception>
  464. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid"/>
  465. <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc"/>, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip"/>
  466. are present inside of <paramref name="additionalHeaderClaims"/>.</exception>
  467. <returns>A JWE in compact serialization format.</returns>
  468. </member>
  469. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateToken(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  470. <summary>
  471. Creates a JWE (Json Web Encryption).
  472. </summary>
  473. <param name="payload">A string containing JSON which represents the JWT token payload.</param>
  474. <param name="signingCredentials">Defines the security key and algorithm that will be used to sign the JWT.</param>
  475. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the JWT.</param>
  476. <param name="compressionAlgorithm">Defines the compression algorithm that will be used to compress the JWT token payload.</param>
  477. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
  478. <exception cref="T:System.ArgumentNullException">if <paramref name="payload"/> is null.</exception>
  479. <exception cref="T:System.ArgumentNullException">if <paramref name="signingCredentials"/> is null.</exception>
  480. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  481. <exception cref="T:System.ArgumentNullException">if <paramref name="compressionAlgorithm"/> is null.</exception>
  482. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception>
  483. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid"/>
  484. <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t"/>, <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc"/>, and/or <see cref="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip"/>
  485. are present inside of <paramref name="additionalHeaderClaims"/>.</exception>
  486. <returns>A JWE in compact serialization format.</returns>
  487. </member>
  488. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CompressToken(System.String,System.String)">
  489. <summary>
  490. Compress a JWT token string.
  491. </summary>
  492. <param name="token"></param>
  493. <param name="compressionAlgorithm"></param>
  494. <exception cref="T:System.ArgumentNullException">if <paramref name="token"/> is null.</exception>
  495. <exception cref="T:System.ArgumentNullException">if <paramref name="compressionAlgorithm"/> is null.</exception>
  496. <exception cref="T:System.NotSupportedException">if the compression algorithm is not supported.</exception>
  497. <returns>Compressed JWT token bytes.</returns>
  498. </member>
  499. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.CreateClaimsIdentity(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  500. <summary>
  501. Creates a <see cref="T:System.Security.Claims.ClaimsIdentity"/> from a <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  502. </summary>
  503. <param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> to use as a <see cref="T:System.Security.Claims.Claim"/> source.</param>
  504. <param name="validationParameters"> Contains parameters for validating the token.</param>
  505. <returns>A <see cref="T:System.Security.Claims.ClaimsIdentity"/> containing the <see cref="P:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken.Claims"/>.</returns>
  506. </member>
  507. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.DecryptToken(Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  508. <summary>
  509. Decrypts a JWE and returns the clear text
  510. </summary>
  511. <param name="jwtToken">the JWE that contains the cypher text.</param>
  512. <param name="validationParameters">contains crypto material.</param>
  513. <returns>the decoded / cleartext contents of the JWE.</returns>
  514. <exception cref="T:System.ArgumentNullException">if <paramref name="jwtToken"/> is null.</exception>
  515. <exception cref="T:System.ArgumentNullException">if <paramref name="validationParameters"/> is null.</exception>
  516. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">if '<paramref name="jwtToken"/> .Enc' is null or empty.</exception>
  517. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">if decompression failed.</exception>
  518. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException">if '<paramref name="jwtToken"/> .Kid' is not null AND decryption fails.</exception>
  519. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">if the JWE was not able to be decrypted.</exception>
  520. </member>
  521. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials)">
  522. <summary>
  523. Encrypts a JWS.
  524. </summary>
  525. <param name="innerJwt">A 'JSON Web Token' (JWT) in JWS Compact Serialization Format.</param>
  526. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt"/>.</param>
  527. <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception>
  528. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  529. <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception>
  530. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  531. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  532. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  533. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
  534. </member>
  535. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.Collections.Generic.IDictionary{System.String,System.Object})">
  536. <summary>
  537. Encrypts a JWS.
  538. </summary>
  539. <param name="innerJwt">A 'JSON Web Token' (JWT) in JWS Compact Serialization Format.</param>
  540. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt"/>.</param>
  541. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
  542. <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception>
  543. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  544. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null.</exception>
  545. <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception>
  546. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  547. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  548. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  549. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
  550. </member>
  551. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String)">
  552. <summary>
  553. Encrypts a JWS.
  554. </summary>
  555. <param name="innerJwt">A 'JSON Web Token' (JWT) in JWS Compact Serialization Format.</param>
  556. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt"/>.</param>
  557. <param name="algorithm">Defines the compression algorithm that will be used to compress the 'innerJwt'.</param>
  558. <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception>
  559. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  560. <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null or empty.</exception>
  561. <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception>
  562. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  563. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  564. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">if compression using <paramref name="algorithm"/> fails.</exception>
  565. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  566. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
  567. </member>
  568. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.EncryptToken(System.String,Microsoft.IdentityModel.Tokens.EncryptingCredentials,System.String,System.Collections.Generic.IDictionary{System.String,System.Object})">
  569. <summary>
  570. Encrypts a JWS.
  571. </summary>
  572. <param name="innerJwt">A 'JSON Web Token' (JWT) in JWS Compact Serialization Format.</param>
  573. <param name="encryptingCredentials">Defines the security key and algorithm that will be used to encrypt the <paramref name="innerJwt"/>.</param>
  574. <param name="algorithm">Defines the compression algorithm that will be used to compress the <paramref name="innerJwt"/></param>
  575. <param name="additionalHeaderClaims">Defines the dictionary containing any custom header claims that need to be added to the outer JWT token header.</param>
  576. <exception cref="T:System.ArgumentNullException">if <paramref name="innerJwt"/> is null or empty.</exception>
  577. <exception cref="T:System.ArgumentNullException">if <paramref name="encryptingCredentials"/> is null.</exception>
  578. <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null or empty.</exception>
  579. <exception cref="T:System.ArgumentNullException">if <paramref name="additionalHeaderClaims"/> is null or empty.</exception>
  580. <exception cref="T:System.ArgumentException">if both <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> and <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/>.<see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> are null.</exception>
  581. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if the CryptoProviderFactory being used does not support the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  582. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if unable to create a token encryption provider for the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  583. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">if compression using 'algorithm' fails.</exception>
  584. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if encryption fails using the <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc"/> (algorithm), <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key"/> pair.</exception>
  585. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">if not using one of the supported content encryption key (CEK) algorithms: 128, 384 or 512 AesCbcHmac (this applies in the case of key wrap only, not direct encryption).</exception>
  586. </member>
  587. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ResolveTokenDecryptionKey(System.String,Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  588. <summary>
  589. Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when decrypting a JWE.
  590. </summary>
  591. <param name="token">The <see cref="T:System.String"/> the token that is being decrypted.</param>
  592. <param name="jwtToken">The <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/> that is being decrypted.</param>
  593. <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
  594. <returns>Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature validation.</returns>
  595. <remarks>If key fails to resolve, then null is returned</remarks>
  596. </member>
  597. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadJsonWebToken(System.String)">
  598. <summary>
  599. Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  600. </summary>
  601. <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
  602. <returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></returns>
  603. <exception cref="T:System.ArgumentNullException"><paramref name="token"/> is null or empty.</exception>
  604. <exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception>
  605. <remarks><para>If the <paramref name="token"/> is in JWE Compact Serialization format, only the protected header will be deserialized.</para>
  606. This method is unable to decrypt the payload. Use <see cref="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)"/>to obtain the payload.</remarks>
  607. </member>
  608. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ReadToken(System.String)">
  609. <summary>
  610. Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/>.
  611. </summary>
  612. <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
  613. <returns>A <see cref="T:Microsoft.IdentityModel.JsonWebTokens.JsonWebToken"/></returns>
  614. <exception cref="T:System.ArgumentNullException"><paramref name="token"/> is null or empty.</exception>
  615. <exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes"/>.</exception>
  616. </member>
  617. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  618. <summary>
  619. Validates a JWS or a JWE.
  620. </summary>
  621. <param name="token">A 'JSON Web Token' (JWT) in JWS or JWE Compact Serialization Format.</param>
  622. <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
  623. <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult"/></returns>
  624. </member>
  625. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  626. <inheritdoc/>
  627. </member>
  628. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.JsonWebTokens.JsonWebToken,System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  629. <summary>
  630. Private method for token validation, responsible for:
  631. (1) Obtaining a configuration from the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ConfigurationManager"/>.
  632. (2) Revalidating using the Last Known Good Configuration (if present), and obtaining a refreshed configuration (if necessary) and revalidating using it.
  633. </summary>
  634. <param name="token">The JWS string, only to be supplied if the token is a JWS.</param>
  635. <param name="outerToken">The outer token of the JWE, only to be supplied if the token is a JWE.</param>
  636. <param name="decryptedJwt">The inner decrypted token of the JWE, only to be supplied if the token is a JWE.</param>
  637. <param name="validationParameters">The <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to be used for validation.</param>
  638. <returns></returns>
  639. </member>
  640. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateSignature(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.BaseConfiguration)">
  641. <summary>
  642. Validates the JWT signature.
  643. </summary>
  644. </member>
  645. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JsonWebTokenHandler.ValidateSignature(System.Byte[],System.Byte[],Microsoft.IdentityModel.Tokens.SecurityKey,System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  646. <summary>
  647. Obtains a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> and validates the signature.
  648. </summary>
  649. <param name="encodedBytes">Bytes to validate.</param>
  650. <param name="signature">Signature to compare against.</param>
  651. <param name="key"><See cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
  652. <param name="algorithm">Crypto algorithm to use.</param>
  653. <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
  654. <param name="validationParameters">Priority will be given to <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CryptoProviderFactory"/> over <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory"/>.</param>
  655. <returns>'true' if signature is valid.</returns>
  656. </member>
  657. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtConstants">
  658. <summary>
  659. Constants for Json Web Tokens.
  660. </summary>
  661. </member>
  662. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.HeaderType">
  663. <summary>
  664. Short header type.
  665. </summary>
  666. </member>
  667. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.HeaderTypeAlt">
  668. <summary>
  669. Long header type.
  670. </summary>
  671. </member>
  672. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.TokenType">
  673. <summary>
  674. Short token type.
  675. </summary>
  676. </member>
  677. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.TokenTypeAlt">
  678. <summary>
  679. Long token type.
  680. </summary>
  681. </member>
  682. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JsonCompactSerializationRegex">
  683. <summary>
  684. JWS - Token format: 'header.payload.signature'. Signature is optional, but '.' is required.
  685. </summary>
  686. </member>
  687. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JweCompactSerializationRegex">
  688. <summary>
  689. JWE - Token format: 'protectedheader.encryptedkey.iv.cyphertext.authenticationtag'.
  690. </summary>
  691. </member>
  692. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JweSegmentCount">
  693. <summary>
  694. The number of parts in a JWE token.
  695. </summary>
  696. </member>
  697. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.JwsSegmentCount">
  698. <summary>
  699. The number of parts in a JWS token.
  700. </summary>
  701. </member>
  702. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.MaxJwtSegmentCount">
  703. <summary>
  704. The maximum number of parts in a JWT.
  705. </summary>
  706. </member>
  707. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtConstants.DirectKeyUseAlg">
  708. <summary>
  709. JWE header alg indicating a shared symmetric key is directly used as CEK.
  710. </summary>
  711. </member>
  712. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames">
  713. <summary>
  714. List of header parameter names see: https://datatracker.ietf.org/doc/html/rfc7519#section-5.
  715. </summary>
  716. </member>
  717. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Alg">
  718. <summary>
  719. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.1
  720. </summary>
  721. </member>
  722. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Cty">
  723. <summary>
  724. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.10
  725. Also: https://datatracker.ietf.org/doc/html/rfc7519#section-5.2
  726. </summary>
  727. </member>
  728. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Enc">
  729. <summary>
  730. See: https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.2
  731. </summary>
  732. </member>
  733. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.IV">
  734. <summary>
  735. See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.7.1.1
  736. </summary>
  737. </member>
  738. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Jku">
  739. <summary>
  740. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.2
  741. </summary>
  742. </member>
  743. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Jwk">
  744. <summary>
  745. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.3
  746. </summary>
  747. </member>
  748. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Kid">
  749. <summary>
  750. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.4
  751. </summary>
  752. </member>
  753. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Typ">
  754. <summary>
  755. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.9
  756. Also: https://datatracker.ietf.org/doc/html/rfc7519#section-5.1
  757. </summary>
  758. </member>
  759. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5c">
  760. <summary>
  761. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.6
  762. </summary>
  763. </member>
  764. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5t">
  765. <summary>
  766. See: https://datatracker.ietf.org/doc/html/rfc7515#page-12
  767. </summary>
  768. </member>
  769. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.X5u">
  770. <summary>
  771. See: https://datatracker.ietf.org/doc/html/rfc7515#section-4.1.5
  772. </summary>
  773. </member>
  774. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Zip">
  775. <summary>
  776. See: https://datatracker.ietf.org/doc/html/rfc7516#section-4.1.3
  777. </summary>
  778. </member>
  779. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Epk">
  780. <summary>
  781. See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.1
  782. </summary>
  783. </member>
  784. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Apu">
  785. <summary>
  786. See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.2
  787. </summary>
  788. </member>
  789. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtHeaderParameterNames.Apv">
  790. <summary>
  791. See: https://datatracker.ietf.org/doc/html/rfc7518#section-4.6.1.3
  792. </summary>
  793. </member>
  794. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames">
  795. <summary>
  796. List of registered claims from different sources
  797. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  798. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  799. </summary>
  800. </member>
  801. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Actort">
  802. <summary>
  803. </summary>
  804. </member>
  805. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Acr">
  806. <summary>
  807. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  808. </summary>
  809. </member>
  810. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Amr">
  811. <summary>
  812. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  813. </summary>
  814. </member>
  815. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Aud">
  816. <summary>
  817. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  818. </summary>
  819. </member>
  820. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.AuthTime">
  821. <summary>
  822. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  823. </summary>
  824. </member>
  825. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Azp">
  826. <summary>
  827. http://openid.net/specs/openid-connect-core-1_0.html#IDToken
  828. </summary>
  829. </member>
  830. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Birthdate">
  831. <summary>
  832. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  833. </summary>
  834. </member>
  835. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.CHash">
  836. <summary>
  837. https://openid.net/specs/openid-connect-core-1_0.html#HybridIDToken
  838. </summary>
  839. </member>
  840. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.AtHash">
  841. <summary>
  842. http://openid.net/specs/openid-connect-core-1_0.html#CodeIDToken
  843. </summary>
  844. </member>
  845. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Email">
  846. <summary>
  847. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  848. </summary>
  849. </member>
  850. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Exp">
  851. <summary>
  852. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  853. </summary>
  854. </member>
  855. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Gender">
  856. <summary>
  857. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  858. </summary>
  859. </member>
  860. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.FamilyName">
  861. <summary>
  862. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  863. </summary>
  864. </member>
  865. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.GivenName">
  866. <summary>
  867. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  868. </summary>
  869. </member>
  870. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Iat">
  871. <summary>
  872. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  873. </summary>
  874. </member>
  875. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Iss">
  876. <summary>
  877. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  878. </summary>
  879. </member>
  880. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Jti">
  881. <summary>
  882. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  883. </summary>
  884. </member>
  885. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Name">
  886. <summary>
  887. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  888. </summary>
  889. </member>
  890. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.NameId">
  891. <summary>
  892. </summary>
  893. </member>
  894. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Nonce">
  895. <summary>
  896. https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest
  897. </summary>
  898. </member>
  899. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Nbf">
  900. <summary>
  901. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  902. </summary>
  903. </member>
  904. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.PhoneNumber">
  905. <summary>
  906. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  907. </summary>
  908. </member>
  909. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.PhoneNumberVerified">
  910. <summary>
  911. https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims
  912. </summary>
  913. </member>
  914. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Prn">
  915. <summary>
  916. </summary>
  917. </member>
  918. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Sid">
  919. <summary>
  920. http://openid.net/specs/openid-connect-frontchannel-1_0.html#OPLogout
  921. </summary>
  922. </member>
  923. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Sub">
  924. <summary>
  925. https://datatracker.ietf.org/doc/html/rfc7519#section-4
  926. </summary>
  927. </member>
  928. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Typ">
  929. <summary>
  930. https://datatracker.ietf.org/doc/html/rfc7519#section-5
  931. </summary>
  932. </member>
  933. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.UniqueName">
  934. <summary>
  935. </summary>
  936. </member>
  937. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtRegisteredClaimNames.Website">
  938. <summary>
  939. </summary>
  940. </member>
  941. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters">
  942. <summary>
  943. Represents the parameters needed to decrypt a JSON Web Token
  944. </summary>
  945. </member>
  946. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Alg">
  947. <summary>
  948. Gets or sets signature algorithm that was used to create the signature.
  949. </summary>
  950. </member>
  951. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.AuthenticationTag">
  952. <summary>
  953. Gets or sets the AuthenticationTag from the original raw data of this instance when it was created.
  954. </summary>
  955. </member>
  956. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Ciphertext">
  957. <summary>
  958. Gets or sets the Ciphertext from the original raw data of this instance when it was created.
  959. </summary>
  960. </member>
  961. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.DecompressionFunction">
  962. <summary>
  963. Gets or sets the function used to attempt decompression with.
  964. </summary>
  965. </member>
  966. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Enc">
  967. <summary>
  968. Gets or sets the encryption algorithm (Enc) of the token.
  969. </summary>
  970. </member>
  971. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.EncodedHeader">
  972. <summary>
  973. Gets the EncodedHeader from the original raw data of this instance when it was created.
  974. </summary>
  975. </member>
  976. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.EncodedToken">
  977. <summary>
  978. Gets or sets the EncodedHeader from the original raw data of this instance when it was created.
  979. </summary>
  980. </member>
  981. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.InitializationVector">
  982. <summary>
  983. Gets or sets the InitializationVector from the original raw data of this instance when it was created.
  984. </summary>
  985. </member>
  986. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Keys">
  987. <summary>
  988. Gets or sets the collection of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>s to attempt to decrypt with.
  989. </summary>
  990. </member>
  991. <member name="P:Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters.Zip">
  992. <summary>
  993. Gets or sets the 'value' of the 'zip' claim.
  994. </summary>
  995. </member>
  996. <member name="T:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities">
  997. <summary>
  998. A class which contains useful methods for processing JWT tokens.
  999. </summary>
  1000. </member>
  1001. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.RegexJws">
  1002. <summary>
  1003. Regex that is used to figure out if a token is in JWS format.
  1004. </summary>
  1005. </member>
  1006. <member name="F:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.RegexJwe">
  1007. <summary>
  1008. Regex that is used to figure out if a token is in JWE format.
  1009. </summary>
  1010. </member>
  1011. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.CreateEncodedSignature(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials)">
  1012. <summary>
  1013. Produces a signature over the <paramref name="input"/>.
  1014. </summary>
  1015. <param name="input">String to be signed</param>
  1016. <param name="signingCredentials">The <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> that contain crypto specs used to sign the token.</param>
  1017. <returns>The bse64urlendcoded signature over the bytes obtained from UTF8Encoding.GetBytes( 'input' ).</returns>
  1018. <exception cref="T:System.ArgumentNullException">'input' or 'signingCredentials' is null.</exception>
  1019. </member>
  1020. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.CreateEncodedSignature(System.String,Microsoft.IdentityModel.Tokens.SigningCredentials,System.Boolean)">
  1021. <summary>
  1022. Produces a signature over the <paramref name="input"/>.
  1023. </summary>
  1024. <param name="input">String to be signed</param>
  1025. <param name="signingCredentials">The <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> that contain crypto specs used to sign the token.</param>
  1026. <param name="cacheProvider">should the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> be cached.</param>
  1027. <returns>The bse64urlendcoded signature over the bytes obtained from UTF8Encoding.GetBytes( 'input' ).</returns>
  1028. <exception cref="T:System.ArgumentNullException"><paramref name="input"/> or <paramref name="signingCredentials"/> is null.</exception>
  1029. </member>
  1030. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.DecompressToken(System.Byte[],System.String)">
  1031. <summary>
  1032. Decompress JWT token bytes.
  1033. </summary>
  1034. <param name="tokenBytes"></param>
  1035. <param name="algorithm"></param>
  1036. <exception cref="T:System.ArgumentNullException">if <paramref name="tokenBytes"/> is null.</exception>
  1037. <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null.</exception>
  1038. <exception cref="T:System.NotSupportedException">if the decompression <paramref name="algorithm"/> is not supported.</exception>
  1039. <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">if decompression using <paramref name="algorithm"/> fails.</exception>
  1040. <returns>Decompressed JWT token</returns>
  1041. </member>
  1042. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.DecryptJwtToken(Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.JsonWebTokens.JwtTokenDecryptionParameters)">
  1043. <summary>
  1044. Decrypts a Json Web Token.
  1045. </summary>
  1046. <param name="jwtToken">The Json Web Token</param>
  1047. <param name="validationParameters">The validation parameters containing cryptographic material.</param>
  1048. <param name="decryptionParameters">The decryption parameters container.</param>
  1049. <returns>The decrypted, and if the 'zip' claim is set, decompressed string representation of the token.</returns>
  1050. </member>
  1051. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GenerateKeyBytes(System.Int32)">
  1052. <summary>
  1053. Generates key bytes.
  1054. </summary>
  1055. </member>
  1056. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GetAllDecryptionKeys(Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  1057. <summary>
  1058. Gets all decryption keys.
  1059. </summary>
  1060. </member>
  1061. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.GetDateTime(System.String,Microsoft.IdentityModel.Json.Linq.JObject)">
  1062. <summary>
  1063. Gets the <see cref="T:System.DateTime"/> using the number of seconds from 1970-01-01T0:0:0Z (UTC)
  1064. </summary>
  1065. <param name="key">Claim in the payload that should map to an integer, float, or string.</param>
  1066. <param name="payload">The payload that contains the desired claim value.</param>
  1067. <remarks>If the claim is not found, the function returns: <see cref="F:System.DateTime.MinValue"/>
  1068. </remarks>
  1069. <exception cref="T:System.FormatException">If the value of the claim cannot be parsed into a long.</exception>
  1070. <returns>The <see cref="T:System.DateTime"/> representation of a claim.</returns>
  1071. </member>
  1072. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.ResolveTokenSigningKey(System.String,System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.BaseConfiguration)">
  1073. <summary>
  1074. Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when validating the signature of a token.
  1075. </summary>
  1076. <param name="kid">The <see cref="T:System.String"/> kid field of the token being validated</param>
  1077. <param name="x5t">The <see cref="T:System.String"/> x5t field of the token being validated</param>
  1078. <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
  1079. <param name="configuration">The <see cref="T:Microsoft.IdentityModel.Tokens.BaseConfiguration"/> that will be used along with the <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> to resolve the signing key</param>
  1080. <returns>Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature validation.</returns>
  1081. <remarks>If key fails to resolve, then null is returned</remarks>
  1082. </member>
  1083. <member name="M:Microsoft.IdentityModel.JsonWebTokens.JwtTokenUtilities.ResolveTokenSigningKey(System.String,System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
  1084. <summary>
  1085. Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when validating the signature of a token.
  1086. </summary>
  1087. <param name="kid">The <see cref="T:System.String"/> kid field of the token being validated</param>
  1088. <param name="x5t">The <see cref="T:System.String"/> x5t field of the token being validated</param>
  1089. <param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
  1090. <returns>Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signature validation.</returns>
  1091. <remarks>If key fails to resolve, then null is returned</remarks>
  1092. </member>
  1093. <member name="T:Microsoft.IdentityModel.JsonWebTokens.LogMessages">
  1094. <summary>
  1095. Log messages and codes
  1096. </summary>
  1097. </member>
  1098. </members>
  1099. </doc>