12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Microsoft.IdentityModel.Tokens</name>
- </assembly>
- <members>
- <member name="T:Microsoft.IdentityModel.Tokens.AsymmetricAdapter">
- <summary>
- This adapter abstracts the 'RSA' differences between versions of .Net targets.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricAdapter.Dispose">
- <summary>
- Calls <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricAdapter.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey">
- <summary>
- Base class for a Security Key that contains Asymmetric key material.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.HasPrivateKey">
- <summary>
- This must be overridden to get a bool indicating if a private key exists.
- </summary>
- <return>true if it has a private key; otherwise, false.</return>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.PrivateKeyStatus">
- <summary>
- Gets the status of the private key.
- </summary>
- <return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.PrivateKeyStatus">
- <summary>
- Enum for the existence of private key
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Exists">
- <summary>
- private key exists for sure
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.DoesNotExist">
- <summary>
- private key doesn't exist for sure
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Unknown">
- <summary>
- unable to determine the existence of private key
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider">
- <summary>
- Provides signature and verification operations for Asymmetric Algorithms using a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.DefaultMinimumAsymmetricKeySizeInBitsForSigningMap">
- <summary>
- Mapping from algorithm to minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize when creating signatures.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.DefaultMinimumAsymmetricKeySizeInBitsForVerifyingMap">
- <summary>
- Mapping from algorithm to minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize when verifying signatures.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> class used to create and verify signatures.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.<see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/></param>
- <param name="algorithm">The signature algorithm to apply.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> class used to create and verify signatures.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param>
- <param name="algorithm">The signature algorithm to apply.</param>
- <param name="willCreateSignatures">If this <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> is required to create signatures then set this to true.</param>
- <para>
- Creating signatures requires that the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> has access to a private key.
- Verifying signatures (the default), does not require access to the private key.
- </para>
- <exception cref="T:System.ArgumentNullException"><paramref name="key"/>is null.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="algorithm"/>is null or empty.</exception>
- <exception cref="T:System.InvalidOperationException"><paramref name="willCreateSignatures"/>is true and there is no private key.</exception>
- <exception cref="T:System.NotSupportedException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- willCreateSignatures is true and <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize is less than the size corresponding to the given algorithm in <see cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForSigningMap"/>.
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize is less than the size corresponding to the algorithm in <see cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForVerifyingMap"/>. Note: this is always checked.
- </exception>
- <exception cref="T:System.InvalidOperationException">If the runtime is unable to create a suitable cryptographic provider.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForSigningMap">
- <summary>
- Gets the mapping from algorithm to the minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize for creating signatures.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForVerifyingMap">
- <summary>
- Gets the mapping from algorithm to the minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize for verifying signatures.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.GetHashAlgorithmName(System.String)">
- <summary>
- Creating a Signature requires the use of a <see cref="T:System.Security.Cryptography.HashAlgorithm"/>.
- This method returns the <see cref="T:System.Security.Cryptography.HashAlgorithmName"/>
- that describes the <see cref="T:System.Security.Cryptography.HashAlgorithm"/>to use when generating a Signature.
- </summary>
- <param name="algorithm">The SignatureAlgorithm in use.</param>
- <returns>The <see cref="T:System.Security.Cryptography.HashAlgorithmName"/> to use.</returns>
- <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null or whitespace.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">if <paramref name="algorithm"/> is not supported.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Sign(System.Byte[])">
- <summary>
- Produces a signature over the 'input' using the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> and algorithm passed to <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"/>.
- </summary>
- <param name="input">The bytes to be signed.</param>
- <returns>A signature over the input.</returns>
- <exception cref="T:System.ArgumentNullException">if <paramref name="input"/> is null.</exception>
- <exception cref="T:System.ArgumentNullException">if <paramref name="input"/>.Length == 0.</exception>
- <exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called. </exception>
- <remarks>Sign is thread safe.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.ValidateAsymmetricSecurityKeySize(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)">
- <summary>
- Validates that an asymmetric key size is of sufficient size for a SignatureAlgorithm.
- </summary>
- <param name="key">The asymmetric key to validate.</param>
- <param name="algorithm">Algorithm for which this key will be used.</param>
- <param name="willCreateSignatures">Whether they key will be used for creating signatures.</param>
- <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception>
- <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/>is null or empty.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">if <paramref name="key"/>.KeySize is less than the minimum
- acceptable size.</exception>
- <remarks>
- <seealso cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForSigningMap"/> for minimum signing sizes.
- <seealso cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForVerifyingMap"/> for minimum verifying sizes.
- </remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Verify(System.Byte[],System.Byte[])">
- <summary>
- Verifies that the <paramref name="signature"/> over <paramref name="input"/> using the
- <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Algorithm"/> specified by this
- <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> are consistent.
- </summary>
- <param name="input">The bytes to generate the signature over.</param>
- <param name="signature">The value to verify against.</param>
- <returns>true if signature matches, false otherwise.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="input"/> is null or has length == 0.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="signature"/> is null or has length == 0.</exception>
- <exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called. </exception>
- <remarks>Verify is thread safe.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)">
- <summary>
- Calls to release managed resources.
- </summary>
- <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.Base64UrlEncoder">
- <summary>
- Encodes and Decodes strings as Base64Url encoding.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.String)">
- <summary>
- The following functions perform base64url encoding which differs from regular base64 encoding as follows
- * padding is skipped so the pad character '=' doesn't have to be percent encoded
- * the 62nd and 63rd regular base64 encoding characters ('+' and '/') are replace with ('-' and '_')
- The changes make the encoding alphabet file and URL safe.
- </summary>
- <param name="arg">string to encode.</param>
- <returns>Base64Url encoding of the UTF8 bytes.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.Byte[],System.Int32,System.Int32)">
- <summary>
- Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify
- the subset as an offset in the input array, and the number of elements in the array to convert.
- </summary>
- <param name="inArray">An array of 8-bit unsigned integers.</param>
- <param name="length">An offset in inArray.</param>
- <param name="offset">The number of elements of inArray to convert.</param>
- <returns>The string representation in base 64 url encodingof length elements of inArray, starting at position offset.</returns>
- <exception cref="T:System.ArgumentNullException">'inArray' is null.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">offset or length is negative OR offset plus length is greater than the length of inArray.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.Byte[])">
- <summary>
- Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify
- the subset as an offset in the input array, and the number of elements in the array to convert.
- </summary>
- <param name="inArray">An array of 8-bit unsigned integers.</param>
- <returns>The string representation in base 64 url encodingof length elements of inArray, starting at position offset.</returns>
- <exception cref="T:System.ArgumentNullException">'inArray' is null.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">offset or length is negative OR offset plus length is greater than the length of inArray.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.DecodeBytes(System.String)">
- <summary>
- Converts the specified string, which encodes binary data as base-64-url digits, to an equivalent 8-bit unsigned integer array.</summary>
- <param name="str">base64Url encoded string.</param>
- <returns>UTF8 bytes.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Decode(System.String)">
- <summary>
- Decodes the string from Base64UrlEncoded to UTF8.
- </summary>
- <param name="arg">string to decode.</param>
- <returns>UTF8 string.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.CompressionAlgorithms">
- <summary>
- Constants for compression algorithms.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory">
- <summary>
- Compression provider factory for compression and decompression.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.#cctor">
- <summary>
- Static constructor that initializes the default <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.#ctor">
- <summary>
- Default constructor for <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.#ctor(Microsoft.IdentityModel.Tokens.CompressionProviderFactory)">
- <summary>
- Constructor that creates a deep copy of given <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/> object.
- </summary>
- <param name="other"><see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/> to copy from.</param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.Default">
- <summary>
- Returns the default <see cref="T:Microsoft.IdentityModel.Tokens.CompressionProviderFactory"/> instance.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.CustomCompressionProvider">
- <summary>
- Extensibility point for custom compression support application wide.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.IsSupportedAlgorithm(System.String)">
- <summary>
- Answers if an algorithm is supported.
- </summary>
- <param name="algorithm">the name of the crypto algorithm.</param>
- <returns>true if the algorithm is supported, false otherwise.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CompressionProviderFactory.CreateCompressionProvider(System.String)">
- <summary>
- Returns a <see cref="T:Microsoft.IdentityModel.Tokens.ICompressionProvider"/> for a specific algorithm.
- </summary>
- <param name="algorithm">the decompression algorithm.</param>
- <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.ICompressionProvider"/>.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.CryptoProviderCache">
- <summary>
- Definition of cache for crypto providers
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SignatureProvider)">
- <summary>
- Returns the cache key to use when looking up an entry into the cache for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" />
- </summary>
- <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to create the key for.</param>
- <returns>the cache key to use for finding a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)">
- <summary>
- Returns the 'key' that will be used to find a crypto provider in this cache.
- </summary>
- <param name="securityKey">the key that is used to by the crypto provider.</param>
- <param name="algorithm">the algorithm that is used by the crypto provider.</param>
- <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
- <returns>the cache key to use for finding a crypto provider.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryAdd(Microsoft.IdentityModel.Tokens.SignatureProvider)">
- <summary>
- Trys to adds a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to this cache.
- </summary>
- <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to cache.</param>
- <returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was added, false if the cache already contained the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/></returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryGetSignatureProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String,System.Boolean,Microsoft.IdentityModel.Tokens.SignatureProvider@)">
- <summary>
- Trys to find a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> in this cache.
- </summary>
- <param name="securityKey">the key that is used to by the crypto provider.</param>
- <param name="algorithm">the algorithm that is used by the crypto provider.</param>
- <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
- <param name="willCreateSignatures">a bool to indicate if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> will be used to sign.</param>
- <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> if found.</param>
- <returns>true if a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was found, false otherwise.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryRemove(Microsoft.IdentityModel.Tokens.SignatureProvider)">
- <summary>
- Trys to remove a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> from this cache.
- </summary>
- <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to remove.</param>
- <returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was removed, false if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was not found.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory">
- <summary>
- Creates cryptographic operators by specifying a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>'s and algorithms.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.Default">
- <summary>
- Returns the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> instance.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.DefaultCacheSignatureProviders">
- <summary>
- Gets or sets the default value for caching
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#cctor">
- <summary>
- Static constructor that initializes the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#ctor">
- <summary>
- Default constructor for <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#ctor(Microsoft.IdentityModel.Tokens.CryptoProviderFactory)">
- <summary>
- Constructor that creates a deep copy of given <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> object.
- </summary>
- <param name="other"><see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> to copy from.</param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CryptoProviderCache">
- <summary>
- Gets the <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CryptoProviderCache"/>
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider">
- <summary>
- Extensibility point for creating custom cryptographic operators.
- </summary>
- <remarks>By default, if set, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> will be called before creating cryptographic operators.
- If true is returned, then <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/> will be called. The <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> will throw if the
- Cryptographic operator returned is not of the correct type.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CacheSignatureProviders">
- <summary>
- Gets or sets a bool controlling if <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> should be cached.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateAuthenticatedEncryptionProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/> for a specific <SecurityKey, Algorithm>.
- </summary>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
- <param name="algorithm">the algorithm to use.</param>
- <returns>an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/></returns>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">'key' is not a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception>
- <exception cref="T:System.ArgumentException">'algorithm, key' pair is not supported.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyWrapProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> for a specific <SecurityKey, Algorithm>.
- </summary>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
- <param name="algorithm">the algorithm to use.</param>
- <returns>an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/></returns>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
- <remarks>
- <para>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"/>.</para>
- </remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyWrapProviderForUnwrap(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> for a specific <SecurityKey, Algorithm>.
- </summary>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
- <param name="algorithm">the algorithm to use.</param>
- <returns>an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/></returns>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
- <remarks>
- <para>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"/>.</para>
- </remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForSigning(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Creates a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> that supports the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signing.</param>
- <param name="algorithm">The algorithm to use for signing.</param>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>' is too small.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> is too small.</exception>
- <exception cref="T:System.ArgumentException"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> is not a <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception>
- <remarks>
- AsymmetricSignatureProviders require access to a PrivateKey for Signing.
- <para>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</para>
- </remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForVerifying(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance supports the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signing.</param>
- <param name="algorithm">The algorithm to use for verifying.</param>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> is too small.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> is too small.</exception>
- <exception cref="T:System.ArgumentException"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>' is not a <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception>
- <remarks>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateHashAlgorithm(System.Security.Cryptography.HashAlgorithmName)">
- <summary>
- Returns a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> for a specific algorithm.
- </summary>
- <param name="algorithm">the name of the hash algorithm to create.</param>
- <returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
- <remarks>When finished with the <see cref="T:System.Security.Cryptography.HashAlgorithm"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>.</remarks>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.InvalidOperationException">'algorithm' is not supported.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateHashAlgorithm(System.String)">
- <summary>
- Returns a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> for a specific algorithm.
- </summary>
- <param name="algorithm">the name of the hash algorithm to create.</param>
- <returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
- <remarks>When finished with the <see cref="T:System.Security.Cryptography.HashAlgorithm"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>.</remarks>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.InvalidOperationException">'algorithm' is not supported.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyedHashAlgorithm(System.Byte[],System.String)">
- <summary>
- Returns a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> for a specific algorithm.
- </summary>
- <param name="algorithm">the keyed hash algorithm to create.</param>
- <param name="keyBytes">bytes to use to create the Keyed Hash</param>
- <returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
- <remarks>When finished with the <see cref="T:System.Security.Cryptography.HashAlgorithm"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>.</remarks>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.InvalidOperationException">'algorithm' is not supported.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.IsSupportedAlgorithm(System.String)">
- <summary>
- Answers if an algorithm is supported
- </summary>
- <param name="algorithm">the name of the cryptographic algorithm</param>
- <returns></returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.IsSupportedAlgorithm(System.String,Microsoft.IdentityModel.Tokens.SecurityKey)">
- <summary>
- Checks if an 'algorithm, key' pair is supported.
- </summary>
- <param name="algorithm">the algorithm to check.</param>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param>
- <returns>true if 'algorithm, key' pair is supported.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)">
- <summary>
- When finished with a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> call this method for cleanup. The default behavior is to call <see cref="M:System.Security.Cryptography.HashAlgorithm.Dispose"/>
- </summary>
- <param name="hashAlgorithm"><see cref="T:System.Security.Cryptography.HashAlgorithm"/> to be released.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)">
- <summary>
- When finished with a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> call this method for cleanup."/>
- </summary>
- <param name="provider"><see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> to be released.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseRsaKeyWrapProvider(Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider)">
- <summary>
- When finished with a <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> call this method for cleanup."/>
- </summary>
- <param name="provider"><see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> to be released.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)">
- <summary>
- When finished with a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> call this method for cleanup. The default behavior is to call <see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose"/>
- </summary>
- <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to be released.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.DateTimeUtil">
- <summary>
- Helper class for adding DateTimes and Timespans.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.Add(System.DateTime,System.TimeSpan)">
- <summary>
- Add a DateTime and a TimeSpan.
- The maximum time is DateTime.MaxTime. It is not an error if time + timespan > MaxTime.
- Just return MaxTime.
- </summary>
- <param name="time">Initial <see cref="T:System.DateTime"/> value.</param>
- <param name="timespan"><see cref="T:System.TimeSpan"/> to add.</param>
- <returns><see cref="T:System.DateTime"/> as the sum of time and timespan.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.GetMaxValue(System.DateTimeKind)">
- <summary>
- Gets the Maximum value for a DateTime specifying kind.
- </summary>
- <param name="kind">DateTimeKind to use.</param>
- <returns>DateTime of specified kind.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.GetMinValue(System.DateTimeKind)">
- <summary>
- Gets the Minimum value for a DateTime specifying kind.
- </summary>
- <param name="kind">DateTimeKind to use.</param>
- <returns>DateTime of specified kind.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.ToUniversalTime(System.Nullable{System.DateTime})">
- <summary>
- Ensures that DataTime is UTC.
- </summary>
- <param name="value"><see cref="T:System.DateTime"/>to convert.</param>
- <returns></returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.ToUniversalTime(System.DateTime)">
- <summary>
- Ensures that DateTime is UTC.
- </summary>
- <param name="value"><see cref="T:System.DateTime"/>to convert.</param>
- <returns></returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider">
- <summary>
- A compression provider that supports compression and decompression using the <see cref="F:Microsoft.IdentityModel.Tokens.CompressionAlgorithms.Deflate"/> algorithm.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider"/> class used to compress and decompress used the <see cref="F:Microsoft.IdentityModel.Tokens.CompressionAlgorithms.Deflate"/> algorithm.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.#ctor(System.IO.Compression.CompressionLevel)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider"/> class used to compress and decompress used the <see cref="F:Microsoft.IdentityModel.Tokens.CompressionAlgorithms.Deflate"/> algorithm.
- <param name="compressionLevel">The compression level to use when compressing.</param>
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.Algorithm">
- <summary>
- Gets the compression algorithm.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.CompressionLevel">
- <summary>
- Specifies whether compression should emphasize speed or compression size.
- Set to <see cref="F:System.IO.Compression.CompressionLevel.Optimal"/> by default.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.Decompress(System.Byte[])">
- <summary>
- Decompress the value using DEFLATE algorithm.
- </summary>
- <param name="value">the bytes to decompress.</param>
- <returns>the decompressed bytes.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.Compress(System.Byte[])">
- <summary>
- Compress the value using the DEFLATE algorithm.
- </summary>
- <param name="value">the bytes to compress.</param>
- <returns>the compressed bytes.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.DeflateCompressionProvider.IsSupportedAlgorithm(System.String)">
- <summary>
- Answers if a compression algorithm is supported.
- </summary>
- <param name="algorithm">the name of the compression algorithm.</param>
- <returns>true if the compression algorithm is supported, false otherwise.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.ECDsaAdapter">
- <summary>
- This adapter abstracts the <see cref="T:System.Security.Cryptography.ECDsa"/> differences between versions of .Net targets.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaAdapter"/> class.
- </summary>
- <exception cref="T:System.PlatformNotSupportedException">
- <see cref="T:System.Security.Cryptography.ECDsa"/> creation is not supported by NETSTANDARD1.4, when running on platforms other than Windows.
- For more details, see https://aka.ms/IdentityModel/create-ecdsa.
- </exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.CreateECDsa(Microsoft.IdentityModel.Tokens.JsonWebKey,System.Boolean)">
- <summary>
- Creates an ECDsa object using the <paramref name="jsonWebKey"/> and <paramref name="usePrivateKey"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.CreateECDsaUsingCNGKey(Microsoft.IdentityModel.Tokens.JsonWebKey,System.Boolean)">
- <summary>
- Creates an ECDsa object using the <paramref name="jsonWebKey"/> and <paramref name="usePrivateKey"/>.
- 'ECParameters' structure is available in .NET Framework 4.7+, .NET Standard 1.6+, and .NET Core 1.0+.
- This method is supported only on Windows as other platforms don't support operations with <see cref="T:System.Security.Cryptography.CngKey"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.GetKeyByteCount(System.String)">
- <summary>
- Returns the size of key in bytes
- </summary>
- <param name="curveId">Represents ecdsa curve -P256, P384, P521</param>
- <returns>Size of the key in bytes</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.GetKeySize(System.String)">
- <summary>
- Returns the size of key in bits.
- </summary>
- <param name="curveId">Represents ecdsa curve -P256, P384, P512</param>
- <returns>Size of the key in bits.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.ECDsaAdapter.KeyBlobMagicNumber">
- <summary>
- Magic numbers identifying ECDSA blob types
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.GetMagicValue(System.String,System.Boolean)">
- <summary>
- Returns the magic value representing the curve corresponding to the curve id.
- </summary>
- <param name="curveId">Represents ecdsa curve -P256, P384, P512</param>
- <param name="willCreateSignatures">Whether the provider will create signatures or not</param>
- <returns>Uint representing the magic number</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaAdapter.SupportsCNGKey">
- <summary>
- Tests if user's runtime platform supports operations using <see cref="T:System.Security.Cryptography.CngKey"/>.
- </summary>
- <returns>True if operations using <see cref="T:System.Security.Cryptography.CngKey"/> are supported on user's runtime platform, false otherwise.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey">
- <summary>
- Represents a ECDsa security key.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.#ctor(System.Security.Cryptography.ECDsa)">
- <summary>
- Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"/>.
- </summary>
- <param name="ecdsa"><see cref="T:System.Security.Cryptography.ECDsa"/></param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.ECDsa">
- <summary>
- <see cref="T:System.Security.Cryptography.ECDsa"/> instance used to initialize the key.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.HasPrivateKey">
- <summary>
- Gets a bool indicating if a private key exists.
- </summary>
- <return>true if it has a private key; otherwise, false.</return>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.PrivateKeyStatus">
- <summary>
- Gets an enum indicating if a private key exists.
- </summary>
- <return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.KeySize">
- <summary>
- Gets <see cref="T:System.Security.Cryptography.ECDsa"/> key size.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials">
- <summary>
- A class for properties that are used for token encryption.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> class.
- </summary>
- <param name="certificate"><see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>.</param>
- <param name="alg">A key wrap algorithm to use when encrypting a session key.</param>
- <param name="enc">Data encryption algorithm to apply.</param>
- <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'alg' is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException">if 'enc' is null or empty.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> class.
- </summary>
- <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when encrypting a session key.</param>
- <param name="alg">A key wrap algorithm to use when encrypting a session key.</param>
- <param name="enc">Data encryption algorithm to apply.</param>
- <exception cref="T:System.ArgumentNullException">if 'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'alg' is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException">if 'enc' is null or empty.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(Microsoft.IdentityModel.Tokens.SymmetricSecurityKey,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> class.
- </summary>
- <remarks> Used in scenarios when a key represents a 'shared' symmetric key.
- For example, SAML 2.0 Assertion will be encrypted using a provided symmetric key
- which won't be serialized to a SAML token.
- </remarks>
- <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> to apply.</param>
- <param name="enc">Data encryption algorithm to apply.</param>
- <exception cref="T:System.ArgumentException">If the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> is not a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception>
- <exception cref="T:System.ArgumentNullException">if 'enc' is null or empty.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Alg">
- <summary>
- Gets the key wrap algorithm used for session key encryption.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc">
- <summary>
- Gets the data encryption algorithm.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory">
- <summary>
- Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> with this property. This factory will be used for creating encryption providers.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for encryption.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider">
- <summary>
- Provides authenticated encryption and decryption services.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/> class used for encryption and decryption.
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param>
- <param name="algorithm">The encryption algorithm to apply.</param>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or whitespace.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">key size is not large enough.</exception>
- <exception cref="T:System.ArgumentException">'algorithm' is not supported.</exception>
- <exception cref="T:System.ArgumentException">a symmetricSignatureProvider is not created.</exception>
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Algorithm">
- <summary>
- Gets the encryption algorithm that is being used.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Context">
- <summary>
- Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/>.
- </summary>
- <remarks>This is null by default. This can be used by applications for extensibility scenarios.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])">
- <summary>
- Encrypts the 'plaintext'
- </summary>
- <param name="plaintext">the data to be encrypted.</param>
- <param name="authenticatedData">will be combined with iv and ciphertext to create an authenticationtag.</param>
- <returns><see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/>containing ciphertext, iv, authenticationtag.</returns>
- <exception cref="T:System.ArgumentNullException">plaintext is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException">authenticationData is null or empty.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">AES crypto operation threw. See inner exception for details.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[],System.Byte[])">
- <summary>
- Encrypts the 'plaintext'
- </summary>
- <param name="plaintext">the data to be encrypted.</param>
- <param name="authenticatedData">will be combined with iv and ciphertext to create an authenticationtag.</param>
- <param name="iv">initialization vector for encryption.</param>
- <returns><see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/>containing ciphertext, iv, authenticationtag.</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="plaintext"/> is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="authenticatedData"/> is null or empty.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">AES crypto operation threw. See inner exception for details.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Decrypt(System.Byte[],System.Byte[],System.Byte[],System.Byte[])">
- <summary>
- Decrypts ciphertext into plaintext
- </summary>
- <param name="ciphertext">the encrypted text to decrypt.</param>
- <param name="authenticatedData">the authenticateData that is used in verification.</param>
- <param name="iv">the initialization vector used when creating the ciphertext.</param>
- <param name="authenticationTag">the authenticationTag that was created during the encyption.</param>
- <returns>decrypted ciphertext</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="ciphertext"/> is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="authenticatedData"/> is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="iv"/> is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="authenticationTag"/> is null or empty.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">signature over authenticationTag fails to verify.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">AES crypto operation threw. See inner exception.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Checks if an 'key, algorithm' pair is supported
- </summary>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/></param>
- <param name="algorithm">the algorithm to check.</param>
- <returns>true if 'key, algorithm' pair is supported.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.GetHmacAlgorithm(System.String)">
- <summary>
- The algorithm parameter logically defines a HMAC algorithm.
- This method returns the HMAC to use.
- </summary>
- <param name="algorithm"></param>
- <returns></returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.GetKeyBytes(Microsoft.IdentityModel.Tokens.SecurityKey)">
- <summary>
- Called to obtain the byte[] needed to create a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>
- </summary>
- <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>that will be used to obtain the byte[].</param>
- <returns><see cref="T:System.Byte"/>[] that is used to populated the KeyedHashAlgorithm.</returns>
- <exception cref="T:System.ArgumentNullException">if <paramref name="key"/> is null.</exception>
- <exception cref="T:System.ArgumentException">if a byte[] can not be obtained from SecurityKey.</exception>
- <remarks><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> are supported.
- <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> .Key is returned</para>
- <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>Base64UrlEncoder.DecodeBytes is called with <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.K"/> if <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kty"/> == JsonWebAlgorithmsKeyTypes.Octet</para>
- </remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.ValidateKeySize(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Checks that the key has sufficient length
- </summary>
- <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that contains bytes.</param>
- <param name="algorithm">the algorithm to apply.</param>
- <exception cref="T:System.ArgumentNullException">if <paramref name="key"/> is null.</exception>
- <exception cref="T:System.ArgumentNullException">if <paramref name="algorithm"/> is null or empty.</exception>
- <exception cref="T:System.ArgumentException">if <paramref name="algorithm"/> is not a supported algorithm.</exception>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult">
- <summary>
- Contains the results of <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])"/> operation.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.Byte[],System.Byte[],System.Byte[])">
- <summary>
- Initializes a new <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/>
- </summary>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used during <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])"/></param>
- <param name="ciphertext">protected text.</param>
- <param name="iv">the initialization vector used.</param>
- <param name="authenticationTag">the bytes that need be passed to <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Decrypt(System.Byte[],System.Byte[],System.Byte[],System.Byte[])"/>.</param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.Ciphertext">
- <summary>
- Gets the Ciphertext.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.IV">
- <summary>
- Gets the initialization vector.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.AuthenticationTag">
- <summary>
- Gets the authentication tag
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider">
- <summary>
- Provides Wrap key and Unwrap key services.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Algorithm">
- <summary>
- Gets the KeyWrap algorithm that is being used.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Context">
- <summary>
- Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.
- </summary>
- <remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose">
- <summary>
- Calls <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)">
- <summary>
- Can be over written in descendants to dispose of internal components.
- </summary>
- <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.UnwrapKey(System.Byte[])">
- <summary>
- Unwrap a key.
- </summary>
- <param name="keyBytes">key to unwrap.</param>
- <returns>Unwrapped key.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.WrapKey(System.Byte[])">
- <summary>
- Wrap a key.
- </summary>
- <param name="keyBytes">the key to be wrapped</param>
- <returns>wrapped key.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider">
- <summary>
- Provides RSA Wrap key and Unwrap key services.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> used for wrapping and un-wrappping keys.
- These keys are usually symmetric session keys that are wrapped using the recipients public key.
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for cryptographic operations.</param>
- <param name="algorithm">The KeyWrap algorithm to apply.</param>
- <param name="willUnwrap">Whether this <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> is required to un-wrap keys. If true, the private key is required.</param>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null.</exception>
- <exception cref="T:System.ArgumentException">The key size doesn't match the algorithm.</exception>
- <exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
- <exception cref="T:System.NotSupportedException">Failed to create RSA algorithm with provided key and algorithm.</exception>
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Algorithm">
- <summary>
- Gets the KeyWrap algorithm that is being used.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Context">
- <summary>
- Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.
- </summary>
- <remarks>This is null by default. This is for use by the application and not used by this SDK.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)">
- <summary>
- Disposes of internal components.
- </summary>
- <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Checks if an algorithm is supported.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param>
- <param name="algorithm">The KeyWrap algorithm to apply.</param>
- <returns>true if the algorithm is supported; otherwise, false.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.UnwrapKey(System.Byte[])">
- <summary>
- Unwrap a key using RSA decryption.
- </summary>
- <param name="keyBytes">the bytes to unwrap.</param>
- <returns>Unwrapped key</returns>
- <exception cref="T:System.ArgumentNullException">'keyBytes' is null or length == 0.</exception>
- <exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to unwrap the wrappedKey.</exception>
- <exception cref="T:System.InvalidOperationException">If the internal RSA algorithm is null.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.WrapKey(System.Byte[])">
- <summary>
- Wrap a key using RSA encryption.
- </summary>
- <param name="keyBytes">the key to be wrapped</param>
- <returns>A wrapped key</returns>
- <exception cref="T:System.ArgumentNullException">'keyBytes' is null or has length == 0.</exception>
- <exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to wrap the 'keyBytes'.</exception>
- <exception cref="T:System.InvalidOperationException">If the internal RSA algorithm is null.</exception>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider">
- <summary>
- Provides Wrap key and Unwrap key services.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> class used for wrap key and unwrap key.
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param>
- <param name="algorithm">The KeyWrap algorithm to apply.</param>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null.</exception>
- <exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
- <exception cref="T:System.ArgumentException">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> cannot be converted to byte array</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The keysize doesn't match the algorithm.</exception>
- <exception cref="T:System.InvalidOperationException">Failed to create symmetric algorithm with provided key and algorithm.</exception>
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Algorithm">
- <summary>
- Gets the KeyWrap algorithm that is being used.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Context">
- <summary>
- Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.
- </summary>
- <remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Dispose(System.Boolean)">
- <summary>
- Disposes of internal components.
- </summary>
- <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.GetSymmetricAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Returns the <see cref="T:System.Security.Cryptography.SymmetricAlgorithm"/>.
- </summary>
- <returns></returns>
- <exception cref="T:System.ArgumentException">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> cannot be converted to byte array</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">The keysize doesn't match the algorithm.</exception>
- <exception cref="T:System.InvalidOperationException">Failed to create symmetric algorithm with provided key and algorithm.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Answers if an algorithm is supported
- </summary>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/></param>
- <param name="algorithm">the algorithm to use</param>
- <returns>true if the algorithm is supported; otherwise, false.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.UnwrapKey(System.Byte[])">
- <summary>
- Unwrap a key using Symmetric decryption.
- </summary>
- <param name="keyBytes">bytes to unwrap</param>
- <returns>Unwraped key</returns>
- <exception cref="T:System.ArgumentNullException">'keyBytes' is null or length == 0.</exception>
- <exception cref="T:System.ArgumentException">'keyBytes' is not a multiple of 8.</exception>
- <exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to unwrap the wrappedKey.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.WrapKey(System.Byte[])">
- <summary>
- Wrap a key using Symmetric encryption.
- </summary>
- <param name="keyBytes">the key to be wrapped</param>
- <returns>The wrapped key result</returns>
- <exception cref="T:System.ArgumentNullException">'keyBytes' is null or has length 0.</exception>
- <exception cref="T:System.ArgumentException">'keyBytes' is not a multiple of 8.</exception>
- <exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to wrap 'keyBytes'.</exception>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.EpochTime">
- <summary>
- Returns the absolute DateTime or the Seconds since Unix Epoch, where Epoch is UTC 1970-01-01T0:0:0Z.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.EpochTime.UnixEpoch">
- <summary>
- DateTime as UTV for UnixEpoch
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.EpochTime.GetIntDate(System.DateTime)">
- <summary>
- Per JWT spec:
- Gets the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the desired date/time.
- </summary>
- <param name="datetime">The DateTime to convert to seconds.</param>
- <remarks>if dateTimeUtc less than UnixEpoch, return 0</remarks>
- <returns>the number of seconds since Unix Epoch.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.EpochTime.DateTime(System.Int64)">
- <summary>
- Creates a DateTime from epoch time.
- </summary>
- <param name="secondsSinceUnixEpoch">Number of seconds.</param>
- <returns>The DateTime in UTC.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException">
- <summary>
- Thrown when JWE compression fails.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenCompressionFailedException"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException">
- <summary>
- Thrown when JWE decompression fails.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecompressionFailedException"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">
- <summary>
- Represents a security token exception when decryption failed.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class with a specified error message
- and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">
- <summary>
- Represents a security token exception when encryption failed.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class with a specified error message
- and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException">
- <summary>
- This exception is thrown when a security token contained a key identifier but the key was not found by the runtime
- when decrypting a token.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">
- <summary>
- Represents a security token exception.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message
- and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException">
- <summary>
- Throw this exception when a received Security Token has expiration time in the past.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.Expires">
- <summary>
- Gets or sets the Expires value that created the validation exception.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException">
- <summary>
- This exception is thrown when 'audience' of a token was not valid.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.InvalidAudience">
- <summary>
- Gets or sets the InvalidAudience that created the validation exception.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">
- <summary>
- This exception is thrown when 'issuer' of a token was not valid.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.InvalidIssuer">
- <summary>
- Gets or sets the InvalidIssuer that created the validation exception.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException">
- <summary>
- This exception is thrown when 'lifetime' of a token was not valid.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.NotBefore">
- <summary>
- Gets or sets the NotBefore value that created the validation exception.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.Expires">
- <summary>
- Gets or sets the Expires value that created the validation exception.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException">
- <summary>
- This exception is thrown when 'signature' of a token was not valid.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSignatureException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException">
- <summary>
- Throw this exception when a received Security Token has an invalid issuer signing key.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.SigningKey">
- <summary>
- Gets or sets the SigningKey that was found invalid.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidSigningKeyException"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">
- <summary>
- Represents a key wrap exception when encryption failed.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"/> class with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException"/> class with a specified error message
- and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">
- <summary>
- This exception is thrown when a security is missing an ExpirationTime.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException">
- <summary>
- Throw this exception when a received Security token has an effective time
- in the future.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.NotBefore">
- <summary>
- Gets or sets the NotBefore value that created the validation exception.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException">
- <summary>
- This exception is thrown when an add to the TokenReplayCache fails.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException">
- <summary>
- Throw this exception when a received Security Token has been replayed.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException.#ctor">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException.#ctor(System.String)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException">
- <summary>
- This exception is thrown when a security token contained a key identifier but the key was not found by the runtime.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenSignatureKeyNotFoundException"/> class.
- </summary>
- <param name="message">Addtional information to be included in the exception and displayed to user.</param>
- <param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException">
- <summary>
- Represents a security token validation exception.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"/> class with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenValidationException"/> class with a specified error message
- and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.ICompressionProvider">
- <summary>
- Compression provider interface.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.ICompressionProvider.Algorithm">
- <summary>
- Gets the compression algorithm.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ICompressionProvider.IsSupportedAlgorithm(System.String)">
- <summary>
- Called to determine if an algorithm is supported.
- </summary>
- <param name="algorithm">the algorithm that defines the compression method.</param>
- <returns>true if supported</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ICompressionProvider.Decompress(System.Byte[])">
- <summary>
- Decompress.
- </summary>
- <param name="value">the value to decompress.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ICompressionProvider.Compress(System.Byte[])">
- <summary>
- Compress.
- </summary>
- <param name="value">the value to decompress.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.ICryptoProvider">
- <summary>
- Provides extensibility for cryptographic operators.
- If custom operators are needed for then <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> can be set to
- return these operators. <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider"/> will be before each creation.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])">
- <summary>
- Called to determine if a cryptographic operation is supported.
- </summary>
- <param name="algorithm">the algorithm that defines the cryptographic operator.</param>
- <param name="args">the arguments required by the cryptographic operator. May be null.</param>
- <returns>true if supported</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])">
- <summary>
- returns a cryptographic operator that supports the algorithm.
- </summary>
- <param name="algorithm">the algorithm that defines the cryptographic operator.</param>
- <param name="args">the arguments required by the cryptographic operator. May be null.</param>
- <remarks>call <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Release(System.Object)"/> when finished with the object.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Release(System.Object)">
- <summary>
- called to release the object returned from <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/>
- </summary>
- <param name="cryptoInstance">the object returned from <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.Create(System.String,System.Object[])"/>.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache">
- <summary>
- Defines a cache for crypto providers.
- Current support is limited to <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> only.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SignatureProvider)">
- <summary>
- Returns the cache key to use when looking up an entry into the cache for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" />
- </summary>
- <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to create the key for.</param>
- <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception>
- <returns>the cache key to use for finding a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)">
- <summary>
- Returns the 'key' that will be used to find a crypto provider in this cache.
- </summary>
- <param name="securityKey">the key that is used to by the crypto provider.</param>
- <param name="algorithm">the algorithm that is used by the crypto provider.</param>
- <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
- <exception cref="T:System.ArgumentNullException">if securityKey is null.</exception>
- <exception cref="T:System.ArgumentNullException">if algorithm is null or empty string.</exception>
- <exception cref="T:System.ArgumentNullException">if typeofProvider is null or empty string.</exception>
- <returns>the cache key to use for finding a crypto provider.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryAdd(Microsoft.IdentityModel.Tokens.SignatureProvider)">
- <summary>
- Trys to adds a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to this cache.
- </summary>
- <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to cache.</param>
- <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception>
- <returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was added, false if the cache already contained the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/></returns>
- <remarks>if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is added <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache"/> will be set to 'this'.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryGetSignatureProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String,System.Boolean,Microsoft.IdentityModel.Tokens.SignatureProvider@)">
- <summary>
- Trys to find a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to this cache.
- </summary>
- <param name="securityKey">the key that is used to by the crypto provider.</param>
- <param name="algorithm">the algorithm that is used by the crypto provider.</param>
- <param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
- <param name="willCreateSignatures">a bool to indicate if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> will be used to sign.</param>
- <param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> if found.</param>
- <exception cref="T:System.ArgumentNullException">if securityKey is null.</exception>
- <exception cref="T:System.ArgumentNullException">if algorithm is null or empty string.</exception>
- <exception cref="T:System.ArgumentNullException">if typeofProvider is null or empty string.</exception>
- <returns>true if a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was found, false otherwise.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.InMemoryCryptoProviderCache.TryRemove(Microsoft.IdentityModel.Tokens.SignatureProvider)">
- <summary>
- Trys to remove a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> from this cache.
- </summary>
- <param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to remove.</param>
- <exception cref="T:System.ArgumentNullException">if signatureProvider is null.</exception>
- <returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was removed, false if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was not found.</returns>
- <remarks>if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is removed <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache"/> will be set to null.</remarks>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator">
- <summary>
- ISecurityTokenValidator
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.CanReadToken(System.String)">
- <summary>
- Returns true if the token can be read, false otherwise.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.CanValidateToken">
- <summary>
- Returns true if a token can be validated.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.MaximumTokenSizeInBytes">
- <summary>
- Gets and sets the maximum size in bytes, that a will be processed.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)">
- <summary>
- Validates a token passed as a string using <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.ITokenReplayCache">
- <summary>
- Interface that defines a simple cache for tacking replaying of security tokens.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ITokenReplayCache.TryAdd(System.String,System.DateTime)">
- <summary>
- Try to add a securityToken.
- </summary>
- <param name="securityToken">the security token to add.</param>
- <param name="expiresOn">the time when security token expires.</param>
- <returns>true if the security token was successfully added.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.ITokenReplayCache.TryFind(System.String)">
- <summary>
- Try to find securityToken
- </summary>
- <param name="securityToken">the security token to find.</param>
- <returns>true if the security token is found.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebAlgorithmsKeyTypes">
- <summary>
- Constants for JsonWebAlgorithms "kty" Key Type (sec 6.1)
- http://tools.ietf.org/html/rfc7518#section-6.1
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKey">
- <summary>
- Represents a JSON Web Key as defined in http://tools.ietf.org/html/rfc7517.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.Create(System.String)">
- <summary>
- Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>.
- </summary>
- <param name="json">A string that contains JSON Web Key parameters in JSON format.</param>
- <returns><see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns>
- <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.#ctor">
- <summary>
- Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.#ctor(System.String)">
- <summary>
- Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> from a json string.
- </summary>
- <param name="json">A string that contains JSON Web Key parameters in JSON format.</param>
- <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.ConvertedSecurityKey">
- <summary>
- If this was converted to or from a SecurityKey, this field will be set.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.AdditionalData">
- <summary>
- When deserializing from JSON any properties that are not defined will be placed here.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Alg">
- <summary>
- Gets or sets the 'alg' (KeyType)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Crv">
- <summary>
- Gets or sets the 'crv' (ECC - Curve)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.D">
- <summary>
- Gets or sets the 'd' (ECC - Private Key OR RSA - Private Exponent)..
- </summary>
- <remarks>Value is formated as: Base64urlUInt</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.DP">
- <summary>
- Gets or sets the 'dp' (RSA - First Factor CRT Exponent)..
- </summary>
- <remarks>Value is formated as: Base64urlUInt</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.DQ">
- <summary>
- Gets or sets the 'dq' (RSA - Second Factor CRT Exponent)..
- </summary>
- <remarks>Value is formated as: Base64urlUInt</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.E">
- <summary>
- Gets or sets the 'e' (RSA - Exponent)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.K">
- <summary>
- Gets or sets the 'k' (Symmetric - Key Value)..
- </summary>
- Base64urlEncoding
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.KeyId">
- <summary>
- Gets the key id of this <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.KeyOps">
- <summary>
- Gets the 'key_ops' (Key Operations)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kid">
- <summary>
- Gets or sets the 'kid' (Key ID)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kty">
- <summary>
- Gets or sets the 'kty' (Key Type)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.N">
- <summary>
- Gets or sets the 'n' (RSA - Modulus)..
- </summary>
- <remarks>Value is formated as: Base64urlEncoding</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Oth">
- <summary>
- Gets or sets the 'oth' (RSA - Other Primes Info)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.P">
- <summary>
- Gets or sets the 'p' (RSA - First Prime Factor)..
- </summary>
- <remarks>Value is formated as: Base64urlUInt</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Q">
- <summary>
- Gets or sets the 'q' (RSA - Second Prime Factor)..
- </summary>
- <remarks>Value is formated as: Base64urlUInt</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.QI">
- <summary>
- Gets or sets the 'qi' (RSA - First CRT Coefficient)..
- </summary>
- <remarks>Value is formated as: Base64urlUInt</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Use">
- <summary>
- Gets or sets the 'use' (Public Key Use)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X">
- <summary>
- Gets or sets the 'x' (ECC - X Coordinate)..
- </summary>
- <remarks>Value is formated as: Base64urlEncoding</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5c">
- <summary>
- Gets the 'x5c' collection (X.509 Certificate Chain)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5t">
- <summary>
- Gets or sets the 'x5t' (X.509 Certificate SHA-1 thumbprint)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5tS256">
- <summary>
- Gets or sets the 'x5t#S256' (X.509 Certificate SHA-1 thumbprint)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.X5u">
- <summary>
- Gets or sets the 'x5u' (X.509 URL)..
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Y">
- <summary>
- Gets or sets the 'y' (ECC - Y Coordinate)..
- </summary>
- <remarks>Value is formated as: Base64urlEncoding</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.KeySize">
- <summary>
- Gets the key size of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKey.HasPrivateKey">
- <summary>
- Gets a bool indicating if a private key exists.
- </summary>
- <return>true if it has a private key; otherwise, false.</return>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.ShouldSerializeKeyOps">
- <summary>
- Gets a bool that determines if the 'key_ops' (Key Operations) property should be serialized.
- This is used by Json.NET in order to conditionally serialize properties.
- </summary>
- <return>true if 'key_ops' (Key Operations) is not empty; otherwise, false.</return>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.ShouldSerializeX5c">
- <summary>
- Gets a bool that determines if the 'x5c' collection (X.509 Certificate Chain) property should be serialized.
- This is used by Json.NET in order to conditionally serialize properties.
- </summary>
- <return>true if 'x5c' collection (X.509 Certificate Chain) is not empty; otherwise, false.</return>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKey.ToString">
- <summary>
- Returns the formatted string: GetType(), Use: 'value', Kid: 'value', Kty: 'value', InternalId: 'value'.
- </summary>
- <returns>string</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter">
- <summary>
- Converts a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>
- Supports: converting to a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> from one of: <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/>, <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>, and <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromSecurityKey(Microsoft.IdentityModel.Tokens.SecurityKey)">
- <summary>
- Converts a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>
- </summary>
- <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to convert.</param>
- <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns>
- <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception>
- <exception cref="T:System.NotSupportedException">if <paramref name="key"/>is not a supported type.</exception>
- <remarks>Supports: <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/>, <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromRSASecurityKey(Microsoft.IdentityModel.Tokens.RsaSecurityKey)">
- <summary>
- Converts a <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>
- </summary>
- <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> to convert.</param>
- <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns>
- <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromX509SecurityKey(Microsoft.IdentityModel.Tokens.X509SecurityKey)">
- <summary>
- Converts a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>
- </summary>
- <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> to convert.</param>
- <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns>
- <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeyConverter.ConvertFromSymmetricSecurityKey(Microsoft.IdentityModel.Tokens.SymmetricSecurityKey)">
- <summary>
- Converts a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> into a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>
- </summary>
- <param name="key">a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> to convert.</param>
- <returns>a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/></returns>
- <exception cref="T:System.ArgumentNullException">if <paramref name="key"/>is null.</exception>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyECTypes">
- <summary>
- Constants for JsonWebKey Elliptical Curve Types
- https://tools.ietf.org/html/rfc7518#section-6.2.1.1
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyParameterNames">
- <summary>
- Names for Json Web Key Values
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet">
- <summary>
- Contains a collection of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> that can be populated from a json string.
- </summary>
- <remarks>provides support for http://tools.ietf.org/html/rfc7517.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.Create(System.String)">
- <summary>
- Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/>.
- </summary>
- <param name="json">a string that contains JSON Web Key parameters in JSON format.</param>
- <returns><see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/></returns>
- <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.#ctor">
- <summary>
- Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.#ctor(System.String)">
- <summary>
- Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/> from a json string.
- </summary>
- <param name="json">a json string containing values.</param>
- <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.#ctor(System.String,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Initializes an new instance of <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKeySet"/> from a json string.
- </summary>
- <param name="json">a json string containing values.</param>
- <param name="jsonSerializerSettings">jsonSerializerSettings</param>
- <exception cref="T:System.ArgumentNullException">If 'json' is null or empty.</exception>
- <exception cref="T:System.ArgumentException">If 'json' fails to deserialize.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.AdditionalData">
- <summary>
- When deserializing from JSON any properties that are not defined will be placed here.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.Keys">
- <summary>
- Gets the <see cref="T:System.Collections.Generic.IList`1"/>.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.JsonWebKeySet.DefaultSkipUnresolvedJsonWebKeys">
- <summary>
- Default value for the flag that controls whether unresolved JsonWebKeys will be included in the resulting collection of <see cref="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.GetSigningKeys"/> method.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.SkipUnresolvedJsonWebKeys">
- <summary>
- Flag that controls whether unresolved JsonWebKeys will be included in the resulting collection of <see cref="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.GetSigningKeys"/> method.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.JsonWebKeySet.GetSigningKeys">
- <summary>
- Returns the JsonWebKeys as a <see cref="T:System.Collections.Generic.IList`1"/>.
- </summary>
- <remarks>
- To include unresolved JsonWebKeys in the resulting <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> collection, set <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKeySet.SkipUnresolvedJsonWebKeys"/> to <c>false</c>.
- </remarks>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeySetParameterNames">
- <summary>
- Names for Json Web Key Set Values
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.JsonWebKeyUseNames">
- <summary>
- Constants for JsonWebKeyUse (sec 4.2)
- http://tools.ietf.org/html/rfc7517#section-4
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.LogMessages">
- <summary>
- Log messages and codes
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey">
- <summary>
- Represents a Rsa security key.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.RsaSecurityKey.#ctor(System.Security.Cryptography.RSAParameters)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> class.
- </summary>
- <param name="rsaParameters"><see cref="T:System.Security.Cryptography.RSAParameters"/></param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.RsaSecurityKey.#ctor(System.Security.Cryptography.RSA)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.RsaSecurityKey"/> class.
- </summary>
- <param name="rsa"><see cref="T:System.Security.Cryptography.RSA"/></param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.HasPrivateKey">
- <summary>
- Gets a bool indicating if a private key exists.
- </summary>
- <return>true if it has a private key; otherwise, false.</return>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.PrivateKeyStatus">
- <summary>
- Gets an enum indicating if a private key exists.
- </summary>
- <return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.KeySize">
- <summary>
- Gets RSA key size.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.Parameters">
- <summary>
- <see cref="T:System.Security.Cryptography.RSAParameters"/> used to initialize the key.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.RsaSecurityKey.Rsa">
- <summary>
- <see cref="T:System.Security.Cryptography.RSA"/> instance used to initialize the key.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityAlgorithms">
- <summary>
- Constants for Security Algorithm.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityKey">
- <summary>
- Base class for Security Key.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityKey.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeySize">
- <summary>
- This must be overridden to get the size of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityKey.KeyId">
- <summary>
- Gets the key id of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory">
- <summary>
- Gets or sets <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityKey.ToString">
- <summary>
- Returns the formatted string: GetType(), KeyId: 'value', InternalId: 'value'.
- </summary>
- <returns>string</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityKeyIdentifierClause">
- <summary>
- Contains information about the keys inside the tokens.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityToken">
- <summary>
- Base class for security token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.Id">
- <summary>
- This must be overridden to get the Id of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.Issuer">
- <summary>
- This must be overridden to get the issuer of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey">
- <summary>
- This must be overridden to get the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.SigningKey">
- <summary>
- This must be overridden to get or set the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey"/> that signed this instance.
- </summary>
- <remarks><see cref="T:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator"/>.ValidateToken(...) can this value when a <see cref="P:Microsoft.IdentityModel.Tokens.SecurityToken.SecurityKey"/> is used to successfully validate a signature.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.ValidFrom">
- <summary>
- This must be overridden to get the time when this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> was Valid.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityToken.ValidTo">
- <summary>
- This must be overridden to get the time when this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> is no longer Valid.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor">
- <summary>
- Contains some information which used to create a security token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Audience">
- <summary>
- Gets or sets the value of the 'audience' claim.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.CompressionAlgorithm">
- <summary>
- Defines the compression algorithm that will be used to compress the JWT token payload.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.EncryptingCredentials">
- <summary>
- Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.EncryptingCredentials"/> used to create a encrypted security token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Expires">
- <summary>
- Gets or sets the value of the 'expiration' claim.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Issuer">
- <summary>
- Gets or sets the issuer of this <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.IssuedAt">
- <summary>
- Gets or sets the time the security token was issued.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.NotBefore">
- <summary>
- Gets or sets the notbefore time for the security token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Claims">
- <summary>
- Gets or sets the <see cref="T:System.Collections.Generic.Dictionary`2"/> which represents the claims that will be used when creating a security token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.SigningCredentials">
- <summary>
- Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.SigningCredentials"/> used to create a security token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor.Subject">
- <summary>
- Gets or sets the <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler">
- <summary>
- Defines the interface for a Security Token Handler.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.#ctor">
- <summary>
- Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CreateSecurityTokenReference(Microsoft.IdentityModel.Tokens.SecurityToken,System.Boolean)">
- <summary>
- Returns <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKeyIdentifierClause"/>.
- </summary>
- <param name="token"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/></param>
- <param name="attached">true if attached; otherwise, false.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CreateToken(Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor)">
- <summary>
- Returns <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
- </summary>
- <param name="tokenDescriptor"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDescriptor"/></param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanValidateToken">
- <summary>
- Gets a value indicating whether this handler supports validation of tokens
- handled by this instance.
- </summary>v
- <returns>'True' if the instance is capable of SecurityToken
- validation.</returns>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanWriteToken">
- <summary>
- Gets a value indicating whether the class provides serialization functionality to serialize token handled
- by this instance.
- </summary>
- <returns>true if the WriteToken method can serialize this token.</returns>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType">
- <summary>
- This must be overridden to get the System.Type of the SecurityToken this instance handles.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanReadToken(System.Xml.XmlReader)">
- <summary>
- Indicates whether the <see cref="T:System.Xml.XmlReader"/> is positioned at an element that can be read.
- </summary>
- <param name="reader">An <see cref="T:System.Xml.XmlReader"/> reader positioned at a start element. The reader should not be advanced.</param>
- <returns>'true' if the token can be read.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.CanReadToken(System.String)">
- <summary>
- Indicates whether the current token string can be read as a token
- of the type handled by this instance.
- </summary>
- <param name="tokenString">The token string thats needs to be read.</param>
- <returns>'True' if the ReadToken method can parse the token string.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ReadToken(System.String)">
- <summary>
- Deserializes from string a token of the type handled by this instance.
- </summary>
- <param name="tokenString">The string to be deserialized.</param>
- <returns>SecurityToken instance which represents the serialized token.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ReadToken(System.Xml.XmlReader)">
- <summary>
- Gets security token.
- </summary>
- <param name="reader"><see cref="T:System.Xml.XmlReader"/>.</param>
- <remarks>SecurityToken instance which represents the serialized token.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.WriteToken(Microsoft.IdentityModel.Tokens.SecurityToken)">
- <summary>
- Serializes to string a token of the type handled by this instance.
- </summary>
- <param name="token">A token of type TokenType.</param>
- <returns>The serialized token.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.WriteToken(System.Xml.XmlWriter,Microsoft.IdentityModel.Tokens.SecurityToken)">
- <summary>
- This must be overridden to serialize to XML a token of the type handled by this instance.
- </summary>
- <param name="writer">The XML writer.</param>
- <param name="token">A token of type <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType"/>.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ReadToken(System.Xml.XmlReader,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- This must be overridden to deserialize token with the provided <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>.
- </summary>
- <param name="reader"><see cref="T:System.Xml.XmlReader"/>.</param>
- <param name="validationParameters">the current <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>.</param>
- <remarks>SecurityToken instance which represents the serialized token.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ValidateToken(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)">
- <summary>
- This must be overridden to validate a token passed as a string using <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>
- </summary>
- <param name="securityToken">A token of type <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType"/>.</param>
- <param name="validationParameters">the current <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>.</param>
- <param name="validatedToken">The token of type <see cref="P:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.TokenType"/> that was validated.</param>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenHandler.ValidateToken(System.Xml.XmlReader,Microsoft.IdentityModel.Tokens.TokenValidationParameters,Microsoft.IdentityModel.Tokens.SecurityToken@)">
- <summary>
- Reads and validates a token using a xmlReader and <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>
- </summary>
- <param name="reader">A <see cref="T:System.Xml.XmlReader"/> pointing at the start element of the token.</param>
- <param name="validationParameters">Contains data and information needed for validation.</param>
- <param name="validatedToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that was validated.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SignatureProvider">
- <summary>
- Provides signature services, signing and verifying.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> class used to create and verify signatures.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param>
- <param name="algorithm">The signature algorithm to apply.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="key"/> is null.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="algorithm"/> is null or empty.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Algorithm">
- <summary>
- Gets the signature algorithm.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Context">
- <summary>
- Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.
- </summary>
- <remarks>This is null by default. This is for use by the application and not used by this SDK.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache">
- <summary>
- Gets or sets the <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.CryptoProviderCache"/> that is associated with this <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose">
- <summary>
- Calls <see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose(System.Boolean)">
- <summary>
- Can be over written in descendants to dispose of internal components.
- </summary>
- <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer</param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Sign(System.Byte[])">
- <summary>
- This must be overridden to produce a signature over the 'input'.
- </summary>
- <param name="input">bytes to sign.</param>
- <returns>signed bytes</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Verify(System.Byte[],System.Byte[])">
- Verifies that the <paramref name="signature"/> over <paramref name="input"/> using the
- <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and <see cref="P:Microsoft.IdentityModel.Tokens.SignatureProvider.Algorithm"/> specified by this
- <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> are consistent.
- <param name="input">the bytes that were signed.</param>
- <param name="signature">signature to compare against.</param>
- <returns>true if the computed signature matches the signature parameter, false otherwise.</returns>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SignatureProvider.WillCreateSignatures">
- <summary>
- Gets or sets a bool indicating if this <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> is expected to create signatures.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SigningCredentials">
- <summary>
- Defines the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>, algorithm and digest for digital signatures.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class.
- </summary>
- <param name="certificate"><see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param>
- <remarks>Algorithm will be set to <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/>.
- the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks>
- <exception cref="T:System.ArgumentNullException">if 'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class.
- </summary>
- <param name="certificate"><see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param>
- <param name="algorithm">The signature algorithm to apply.</param>
- <remarks>the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks>
- <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class.
- </summary>
- <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param>
- <param name="algorithm">The signature algorithm to apply.</param>
- <remarks>the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.HmacSha256Signature"/> implies Sha256.</remarks>
- <exception cref="T:System.ArgumentNullException">if 'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SigningCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SigningCredentials"/> class.
- </summary>
- <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param>
- <param name="algorithm">The signature algorithm to apply.</param>
- <param name="digest">The digest algorithm to apply.</param>
- <exception cref="T:System.ArgumentNullException">if 'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException">if 'digest' is null or empty.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Algorithm">
- <summary>
- Gets the signature algorithm.
- </summary>
- <exception cref="T:System.ArgumentNullException">if 'value' is null or empty.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Digest">
- <summary>
- Gets the digest algorithm.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.CryptoProviderFactory">
- <summary>
- Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.SigningCredentials.CryptoProviderFactory"/> with this property. This factory will be used for creating signature providers.
- </summary>
- <remarks>This will have precedence over <see cref="P:Microsoft.IdentityModel.Tokens.SecurityKey.CryptoProviderFactory"/></remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Key">
- <summary>
- Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for signature creation or validation.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SigningCredentials.Kid">
- <summary>
- Gets the key id associated with <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SupportedAlgorithms">
- <summary>
- Defines the default set of algorithms this library supports
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SupportedAlgorithms.IsSupportedAlgorithm(System.String,Microsoft.IdentityModel.Tokens.SecurityKey)">
- <summary>
- Checks if an 'algorithm, key' pair is supported.
- </summary>
- <param name="algorithm">the algorithm to check.</param>
- <param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param>
- <returns>true if 'algorithm, key' pair is supported.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey">
- <summary>
- Represents a symmetric security key.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.#ctor(System.Byte[])">
- <summary>
- Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> instance.
- </summary>
- <param name="key">The byte array of the key.</param>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.KeySize">
- <summary>
- Gets the key size.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey.Key">
- <summary>
- Gets the byte array of the key.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider">
- <summary>
- Provides signing and verifying operations using a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and specifying an algorithm.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.DefaultMinimumSymmetricKeySizeInBits">
- <summary>
- This is the minimum <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.KeySize when creating and verifying signatures.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider"/> class that uses an <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to create and / or verify signatures over a array of bytes.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param>
- <param name="algorithm">The signature algorithm to use.</param>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.NotSupportedException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">'<see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize' is smaller than <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.MinimumSymmetricKeySizeInBits"/>.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider"/> class that uses an <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to create and / or verify signatures over a array of bytes.
- </summary>
- <param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param>
- <param name="algorithm">The signature algorithm to use.</param>
- <param name="willCreateSignatures">indicates if this <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider"/> will be used to create signatures.</param>
- <exception cref="T:System.ArgumentNullException">'key' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
- <exception cref="T:System.NotSupportedException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">'<see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize' is smaller than <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.MinimumSymmetricKeySizeInBits"/>.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.MinimumSymmetricKeySizeInBits">
- <summary>
- Gets or sets the minimum <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.KeySize"/>.
- </summary>
- <exception cref="T:System.ArgumentOutOfRangeException">'value' is smaller than <see cref="F:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.DefaultMinimumSymmetricKeySizeInBits"/>.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.GetKeyBytes(Microsoft.IdentityModel.Tokens.SecurityKey)">
- <summary>
- Called to obtain the byte[] needed to create a <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.KeyedHashAlgorithm"/>
- </summary>
- <param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>that will be used to obtain the byte[].</param>
- <returns><see cref="T:System.Byte"/>[] that is used to populated the KeyedHashAlgorithm.</returns>
- <exception cref="T:System.ArgumentNullException">if key is null.</exception>
- <exception cref="T:System.ArgumentException">if a byte[] can not be obtained from SecurityKey.</exception>
- <remarks><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> are supported.
- <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> .Key is returned</para>
- <para>For a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>Base64UrlEncoder.DecodeBytes is called with <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.K"/> if <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kty"/> == JsonWebAlgorithmsKeyTypes.Octet</para>
- </remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.GetKeyedHashAlgorithm(System.Byte[],System.String)">
- <summary>
- Returns the <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.KeyedHashAlgorithm"/>.
- </summary>
- <param name="algorithm">The hash algorithm to use to create the hash value.</param>
- <param name="keyBytes">The byte array of the key.</param>
- <returns></returns>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.KeyedHashAlgorithm">
- <summary>
- Gets the <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.KeyedHashAlgorithm"/> for this <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Sign(System.Byte[])">
- <summary>
- Produces a signature over the 'input' using the <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and 'algorithm' passed to <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/>.
- </summary>
- <param name="input">The bytes to sign.</param>
- <returns>Signed bytes</returns>
- <exception cref="T:System.ArgumentNullException">'input' is null. </exception>
- <exception cref="T:System.ArgumentException">'input.Length' == 0. </exception>
- <exception cref="T:System.ObjectDisposedException"><see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception>
- <exception cref="T:System.InvalidOperationException"><see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.KeyedHashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception>
- <remarks>Sign is thread safe.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Verify(System.Byte[],System.Byte[])">
- <summary>
- Verifies that a signature created over the 'input' matches the signature. Using <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and 'algorithm' passed to <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/>.
- </summary>
- <param name="input">The bytes to verify.</param>
- <param name="signature">signature to compare against.</param>
- <returns>true if computed signature matches the signature parameter, false otherwise.</returns>
- <exception cref="T:System.ArgumentNullException">'input' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'signature' is null.</exception>
- <exception cref="T:System.ArgumentException">'input.Length' == 0.</exception>
- <exception cref="T:System.ArgumentException">'signature.Length' == 0. </exception>
- <exception cref="T:System.ObjectDisposedException"><see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception>
- <exception cref="T:System.InvalidOperationException">If the internal <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.KeyedHashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception>
- <remarks>Verify is thread safe.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Verify(System.Byte[],System.Byte[],System.Int32)">
- <summary>
- Verifies that a signature created over the 'input' matches the signature. Using <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and 'algorithm' passed to <see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)"/>.
- </summary>
- <param name="input">The bytes to verify.</param>
- <param name="signature">signature to compare against.</param>
- <param name="length">number of bytes of signature to use.</param>
- <returns>true if computed signature matches the signature parameter, false otherwise.</returns>
- <exception cref="T:System.ArgumentNullException">'input' is null.</exception>
- <exception cref="T:System.ArgumentNullException">'signature' is null.</exception>
- <exception cref="T:System.ArgumentException">'input.Length' == 0.</exception>
- <exception cref="T:System.ArgumentException">'signature.Length' == 0. </exception>
- <exception cref="T:System.ArgumentException">'length < 1'</exception>
- <exception cref="T:System.ObjectDisposedException"><see cref="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called.</exception>
- <exception cref="T:System.InvalidOperationException">If the internal <see cref="P:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.KeyedHashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.SymmetricSignatureProvider.Dispose(System.Boolean)">
- <summary>
- Disposes of internal components.
- </summary>
- <param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.TokenContext">
- <summary>
- An opaque context used to store work when working with authentication artifacts.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.TokenContext.#ctor">
- <summary>
- Instantiates a new <see cref="T:Microsoft.IdentityModel.Tokens.TokenContext"/> with a default activityId.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.TokenContext.#ctor(System.Guid)">
- <summary>
- Instantiates a new <see cref="T:Microsoft.IdentityModel.Tokens.TokenContext"/> with an activityId.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenContext.ActivityId">
- <summary>
- Gets or set a <see cref="T:System.Guid"/> that will be used in the call to EventSource.SetCurrentThreadActivityId before logging.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenContext.CaptureLogs">
- <summary>
- Gets or sets a boolean controlling if logs are written into the context.
- Useful when debugging.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenContext.Logs">
- <summary>
- The collection of logs associated with a request. Use <see cref="P:Microsoft.IdentityModel.Tokens.TokenContext.CaptureLogs"/> to control capture.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.TokenHandler">
- <summary>
- Defines properties shared across all security token handlers.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.TokenHandler.DefaultTokenLifetimeInMinutes">
- <summary>
- Default lifetime of tokens created. When creating tokens, if 'expires' and 'notbefore' are both null,
- then a default will be set to: expires = DateTime.UtcNow, notbefore = DateTime.UtcNow + TimeSpan.FromMinutes(TokenLifetimeInMinutes).
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes">
- <summary>
- Gets and sets the maximum token size in bytes that will be processed.
- </summary>
- <exception cref="T:System.ArgumentOutOfRangeException">'value' less than 1.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenHandler.SetDefaultTimesOnTokenCreation">
- <summary>
- Gets or sets a bool that controls if token creation will set default 'exp', 'nbf' and 'iat' if not specified.
- </summary>
- <remarks>See: <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.TokenLifetimeInMinutes"/> for configuration.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenHandler.TokenLifetimeInMinutes">
- <summary>
- Gets or sets the token lifetime in minutes.
- </summary>
- <remarks>Used during token creation to set the default expiration ('exp'). </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">'value' less than 1.</exception>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.AudienceValidator">
- <summary>
- Definition for AudienceValidator.
- </summary>
- <param name="audiences">The audiences found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <returns>true if the audience is considered valid.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyResolver">
- <summary>
- Definition for IssuerSigningKeyResolver.
- </summary>
- <param name="token">The <see cref="T:System.String"/> representation of the token that is being validated.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated. It may be null.</param>
- <param name="kid">A key identifier. It may be null.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when validating a signature.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.IssuerSigningKeyValidator">
- <summary>
- Definition for IssuerSigningKeyValidator.
- </summary>
- <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.IssuerValidator">
- <summary>
- Definition for IssuerValidator.
- </summary>
- <param name="issuer">The issuer to validate.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <returns>The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity".</returns>
- <remarks>The delegate should return a non null string that represents the 'issuer'. If null a default value will be used.</remarks>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.LifetimeValidator">
- <summary>
- Definition for LifetimeValidator.
- </summary>
- <param name="notBefore">The 'notBefore' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="expires">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.TokenReplayValidator">
- <summary>
- Definition for TokenReplayValidator.
- </summary>
- <param name="expirationTime">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <returns></returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.SignatureValidator">
- <summary>
- Definition for SignatureValidator.
- </summary>
- <param name="token">A securityToken with a signature.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.TokenReader">
- <summary>
- Definition for TokenReader.
- </summary>
- <param name="token">A securityToken with a signature.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.TokenDecryptionKeyResolver">
- <summary>
- Definition for TokenDecryptionKeyResolver.
- </summary>
- <param name="token">The <see cref="T:System.String"/> representation of the token to be decrypted.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> to be decrypted. The runtime by default passes null.</param>
- <param name="kid">A key identifier. It may be null.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use when decrypting the token.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters">
- <summary>
- Contains a set of parameters that are used by a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenHandler"/> when validating a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.TokenValidationParameters.DefaultAuthenticationType">
- <summary>
- This is the fallback authenticationtype that a <see cref="T:Microsoft.IdentityModel.Tokens.ISecurityTokenValidator"/> will use if nothing is set.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.TokenValidationParameters.DefaultClockSkew">
- <summary>
- Default for the clock skew.
- </summary>
- <remarks>300 seconds (5 minutes).</remarks>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.TokenValidationParameters.DefaultMaximumTokenSizeInBytes">
- <summary>
- Default for the maximm token size.
- </summary>
- <remarks>250 KB (kilobytes).</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.#ctor(Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- Copy constructor for <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ActorValidationParameters">
- <summary>
- Gets or sets <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AudienceValidator">
- <summary>
- Gets or sets a delegate that will be used to validate the audience.
- </summary>
- <remarks>
- If set, this delegate will be called to validate the 'audience' instead of normal processing.
- If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateAudience"/> is false, this delegate will not be called.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReader">
- <summary>
- Gets or sets a delegate that will be used to read the token.
- </summary>
- <remarks>
- If set, this delegate will be called to read the token instead of normal processing.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AuthenticationType">
- <summary>
- Gets or sets the AuthenticationType when creating a <see cref="T:System.Security.Claims.ClaimsIdentity"/>.
- </summary>
- <exception cref="T:System.ArgumentNullException">If 'value' is null or whitespace.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ClockSkew">
- <summary>
- Gets or sets the clock skew to apply when validating a time.
- </summary>
- <exception cref="T:System.ArgumentOutOfRangeException">If 'value' is less than 0.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.Clone">
- <summary>
- Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> with values copied from this object.
- </summary>
- <returns>A new <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> object copied from this object</returns>
- <remarks>This is a shallow Clone.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CreateClaimsIdentity(Microsoft.IdentityModel.Tokens.SecurityToken,System.String)">
- <summary>
- Creates a <see cref="T:System.Security.Claims.ClaimsIdentity"/> using:
- <para><see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.AuthenticationType"/></para>
- <para>'NameClaimType': If NameClaimTypeRetriever is set, call delegate, else call NameClaimType. If the result is a null or empty string, use <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultNameClaimType"/></para>.
- <para>'RoleClaimType': If RoleClaimTypeRetriever is set, call delegate, else call RoleClaimType. If the result is a null or empty string, use <see cref="F:System.Security.Claims.ClaimsIdentity.DefaultRoleClaimType"/></para>.
- </summary>
- <returns>A <see cref="T:System.Security.Claims.ClaimsIdentity"/> with Authentication, NameClaimType and RoleClaimType set.</returns>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CryptoProviderFactory">
- <summary>
- Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.CryptoProviderFactory"/> with this property. This factory will be used for creating signature providers.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenDecryptionKey">
- <summary>
- Gets or sets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is to be used for decryption.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenDecryptionKeyResolver">
- <summary>
- Gets or sets a delegate that will be called to retreive a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for decryption.
- </summary>
- <remarks>
- This <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> will be used to decrypt the token. This can be helpful when the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> does not contain a key identifier.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyValidator">
- <summary>
- Gets or sets a delegate for validating the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token.
- </summary>
- <remarks>
- If set, this delegate will be called to validate the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the token, instead of normal processing.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKey">
- <summary>
- Gets or sets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is to be used for signature validation.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeyResolver">
- <summary>
- Gets or sets a delegate that will be called to retrieve a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used for signature validation.
- </summary>
- <remarks>
- This <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> will be used to check the signature. This can be helpful when the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> does not contain a key identifier.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerSigningKeys">
- <summary>
- Gets or sets an <see cref="T:System.Collections.Generic.IEnumerable`1"/> used for signature validation.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.IssuerValidator">
- <summary>
- Gets or sets a delegate that will be used to validate the issuer of the token.
- </summary>
- <remarks>
- If set, this delegate will be called to validate the 'issuer' of the token, instead of normal processing.
- If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is false, this delegate will not be called.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.LifetimeValidator">
- <summary>
- Gets or sets a delegate that will be used to validate the lifetime of the token
- </summary>
- <remarks>
- If set, this delegate will be called to validate the lifetime of the token, instead of normal processing.
- If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateLifetime"/> is false, this delegate will not be called.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayValidator">
- <summary>
- Gets or sets a delegate that will be used to validate the token replay of the token
- </summary>
- <remarks>
- If set, this delegate will be called to validate the token replay of the token, instead of normal processing.
- If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateTokenReplay"/> is false, this delegate will not be called.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.NameClaimType">
- <summary>
- Gets or sets a <see cref="T:System.String"/> that defines the <see cref="P:System.Security.Claims.ClaimsIdentity.NameClaimType"/>.
- </summary>
- <remarks>
- Controls the value <see cref="P:System.Security.Claims.ClaimsIdentity.Name"/> returns. It will return the first <see cref="P:System.Security.Claims.Claim.Value"/> where the <see cref="P:System.Security.Claims.Claim.Type"/> equals <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.NameClaimType"/>.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RoleClaimType">
- <summary>
- Gets or sets the <see cref="T:System.String"/> that defines the <see cref="P:System.Security.Claims.ClaimsIdentity.RoleClaimType"/>.
- </summary>
- <remarks>
- <para>Controls the results of <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</para>
- <para>Each <see cref="T:System.Security.Claims.Claim"/> where <see cref="P:System.Security.Claims.Claim.Type"/> == <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RoleClaimType"/> will be checked for a match against the 'string' passed to <see cref="M:System.Security.Claims.ClaimsPrincipal.IsInRole(System.String)"/>.</para>
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.NameClaimTypeRetriever">
- <summary>
- Gets or sets a delegate that will be called to obtain the NameClaimType to use when creating a ClaimsIdentity
- after validating a token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.PropertyBag">
- <summary>
- Gets or sets the <see cref="T:System.Collections.Generic.IDictionary`2"/> that contains a collection of custom key/value pairs. This allows addition of parameters that could be used in custom token validation scenarios.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireAudience">
- <summary>
- Gets or sets a value indicating whether SAML tokens must have at least one AudienceRestriction.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireExpirationTime">
- <summary>
- Gets or sets a value indicating whether tokens must have an 'expiration' value.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireSignedTokens">
- <summary>
- Gets or sets a value indicating whether a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> can be considered valid if not signed.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RoleClaimTypeRetriever">
- <summary>
- Gets or sets a delegate that will be called to obtain the RoleClaimType to use when creating a ClaimsIdentity
- after validating a token.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.SaveSigninToken">
- <summary>
- Gets or sets a boolean to control if the original token should be saved after the security token is validated.
- </summary>
- <remarks>The runtime will consult this value and save the original token that was validated.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.SignatureValidator">
- <summary>
- Gets or sets a delegate that will be used to validate the signature of the token.
- </summary>
- <remarks>
- If set, this delegate will be called to signature of the token, instead of normal processing.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenDecryptionKeys">
- <summary>
- Gets or sets the <see cref="T:System.Collections.Generic.IEnumerable`1"/> that is to be used for decrypting inbound tokens.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache">
- <summary>
- Gets or set the <see cref="T:Microsoft.IdentityModel.Tokens.ITokenReplayCache"/> that store tokens that can be checked to help detect token replay.
- </summary>
- <remarks>If set, then tokens must have an expiration time or the runtime will fault.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateActor">
- <summary>
- Gets or sets a value indicating if an actor token is detected, whether it should be validated.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateAudience">
- <summary>
- Gets or sets a boolean to control if the audience will be validated during token validation.
- </summary>
- <remarks>Validation of the audience, mitigates forwarding attacks. For example, a site that receives a token, could not replay it to another side.
- A forwarded token would contain the audience of the original site.</remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer">
- <summary>
- Gets or sets a boolean to control if the issuer will be validated during token validation.
- </summary>
- <remarks>
- Validation of the issuer mitigates forwarding attacks that can occur when an
- IdentityProvider represents multiple tenants and signs tokens with the same keys.
- It is possible that a token issued for the same audience could be from a different tenant. For example an application could accept users from
- contoso.onmicrosoft.com but not fabrikam.onmicrosoft.com, both valid tenants. A application that accepts tokens from fabrikam could forward them
- to the application that accepts tokens for contoso.
- </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateLifetime">
- <summary>
- Gets or sets a boolean to control if the lifetime will be validated during token validation.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuerSigningKey">
- <summary>
- Gets or sets a boolean that controls if validation of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the securityToken is called.
- </summary>
- <remarks>It is possible for tokens to contain the public key needed to check the signature. For example, X509Data can be hydrated into an X509Certificate,
- which can be used to validate the signature. In these cases it is important to validate the SigningKey that was used to validate the signature. </remarks>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateTokenReplay">
- <summary>
- Gets or sets a boolean to control if the token replay will be validated during token validation.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience">
- <summary>
- Gets or sets a string that represents a valid audience that will be used to check against the token's audience.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences">
- <summary>
- Gets or sets the <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains valid audiences that will be used to check against the token's audience.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer">
- <summary>
- Gets or sets a <see cref="T:System.String"/> that represents a valid issuer that will be used to check against the token's issuer.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers">
- <summary>
- Gets or sets the <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains valid issuers that will be used to check against the token's issuer.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.UniqueId">
- <summary>
- Generates unique IDs.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateUniqueId">
- <summary>
- Creates a unique ID suitable for use in an xml:id field. The value is
- not hard to guess but is unique.
- </summary>
- <returns>The unique ID.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateUniqueId(System.String)">
- <summary>
- Creates a unique ID similar to that created by CreateNonRandomId,
- but instead of an underscore, the supplied prefix is used.
- </summary>
- <param name="prefix">The prefix to use.</param>
- <returns>The unique ID, with the given prefix.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateRandomId">
- <summary>
- Creates a unique, random ID suitable for use in an xml:id field. The
- value is hard to guess and unique.
- </summary>
- <returns>The unique ID.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateRandomId(System.String)">
- <summary>
- Creates a unique, random ID similar to that created by CreateRandomId,
- but instead of an underscore, the supplied prefix is used.
- </summary>
- <param name="prefix">The prefix to use.</param>
- <returns>The random URI.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.UniqueId.CreateRandomUri">
- <summary>
- Creates a unique, random ID suitable for use as a URI. The value is
- hard to guess and unique. The URI is in the urn:uuid: namespace.
- </summary>
- <returns>The random URI.</returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.Utility">
- <summary>
- Contains some utility methods.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.Utility.Empty">
- <summary>
- A string with "empty" value.
- </summary>
- </member>
- <member name="F:Microsoft.IdentityModel.Tokens.Utility.Null">
- <summary>
- A string with "null" value.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Utility.CloneByteArray(System.Byte[])">
- <summary>
- Creates a copy of the byte array.
- </summary>
- <param name="src">The resource array.</param>
- <returns>A copy of the byte array.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Utility.SerializeAsSingleCommaDelimitedString(System.Collections.Generic.IEnumerable{System.String})">
- <summary>
- Serializes the list of strings into string as follows:
- 'str1','str2','str3' ...
- </summary>
- <param name="strings">
- The strings used to build a comma delimited string.
- </param>
- <returns>
- The single <see cref="T:System.String"/>.
- </returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Utility.IsHttps(System.String)">
- <summary>
- Returns whether the input string is https.
- </summary>
- <param name="address">The input string.</param>
- <remarks>true if the input string is https; otherwise, false.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Utility.IsHttps(System.Uri)">
- <summary>
- Returns whether the input uri is https.
- </summary>
- <param name="uri"><see cref="T:System.Uri"/>.</param>
- <returns>true if the input uri is https; otherwise, false.</returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Utility.AreEqual(System.Byte[],System.Byte[])">
- <summary>
- Compares two byte arrays for equality. Hash size is fixed normally it is 32 bytes.
- The attempt here is to take the same time if an attacker shortens the signature OR changes some of the signed contents.
- </summary>
- <param name="a">
- One set of bytes to compare.
- </param>
- <param name="b">
- The other set of bytes to compare with.
- </param>
- <returns>
- true if the bytes are equal, false otherwise.
- </returns>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Utility.AreEqual(System.Byte[],System.Byte[],System.Int32)">
- <summary>
- Compares two byte arrays for equality. Hash size is fixed normally it is 32 bytes.
- The attempt here is to take the same time if an attacker shortens the signature OR changes some of the signed contents.
- </summary>
- <param name="a">
- One set of bytes to compare.
- </param>
- <param name="b">
- The other set of bytes to compare with.
- </param>
- <param name="length">length of array to check</param>
- <returns>
- true if the bytes are equal, false otherwise.
- </returns>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.Validators">
- <summary>
- AudienceValidator
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateAudience(System.Collections.Generic.IEnumerable{System.String},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- Determines if the audiences found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> are valid.
- </summary>
- <param name="audiences">The audiences found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <exception cref="T:System.ArgumentNullException">If 'vaidationParameters' is null.</exception>
- <exception cref="T:System.ArgumentNullException">If 'audiences' is null and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateAudience"/> is true.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences"/> is null.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidAudienceException">If none of the 'audiences' matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudience"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidAudiences"/>.</exception>
- <remarks>An EXACT match is required.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuer(System.String,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- Determines if an issuer found in a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> is valid.
- </summary>
- <param name="issuer">The issuer to validate</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> that is being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <returns>The issuer to use when creating the "Claim"(s) in a "ClaimsIdentity".</returns>
- <exception cref="T:System.ArgumentNullException">If 'vaidationParameters' is null.</exception>
- <exception cref="T:System.ArgumentNullException">If 'issuer' is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidateIssuer"/> is true.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> is null or whitespace and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/> is null.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidIssuerException">If 'issuer' failed to matched either <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuer"/> or one of <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ValidIssuers"/>.</exception>
- <remarks>An EXACT match is required.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateIssuerSecurityKey(Microsoft.IdentityModel.Tokens.SecurityKey,Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- Validates the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
- </summary>
- <param name="securityKey">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that signed the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <exception cref="T:System.ArgumentNullException"> if 'securityKey' is null and ValidateIssuerSigningKey is true.</exception>
- <exception cref="T:System.ArgumentNullException"> if 'securityToken' is null and ValidateIssuerSigningKey is true.</exception>
- <exception cref="T:System.ArgumentNullException"> if 'vaidationParameters' is null.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateLifetime(System.Nullable{System.DateTime},System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- Validates the lifetime of a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.
- </summary>
- <param name="notBefore">The 'notBefore' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="expires">The 'expiration' time found in the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/>.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <exception cref="T:System.ArgumentNullException">If 'vaidationParameters' is null.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If 'expires.HasValue' is false and <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.RequireExpirationTime"/> is true.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenInvalidLifetimeException">If 'notBefore' is > 'expires'.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNotYetValidException">If 'notBefore' is > DateTime.UtcNow.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException">If 'expires' is < DateTime.UtcNow.</exception>
- <remarks>All time comparisons apply <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.ClockSkew"/>.</remarks>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateTokenReplay(System.Nullable{System.DateTime},System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- Validates if a token has been replayed.
- </summary>
- <param name="expirationTime">When does the security token expire.</param>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <exception cref="T:System.ArgumentNullException">If 'securityToken' is null or whitespace.</exception>
- <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null or whitespace.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/> is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException">If the 'securityToken' is found in the cache.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException">If the 'securityToken' could not be added to the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/>.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.Validators.ValidateTokenReplay(System.String,System.Nullable{System.DateTime},Microsoft.IdentityModel.Tokens.TokenValidationParameters)">
- <summary>
- Validates if a token has been replayed.
- </summary>
- <param name="securityToken">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken"/> being validated.</param>
- <param name="expirationTime">When does the security token expire.</param>
- <param name="validationParameters"><see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters"/> required for validation.</param>
- <exception cref="T:System.ArgumentNullException">If 'securityToken' is null or whitespace.</exception>
- <exception cref="T:System.ArgumentNullException">If 'validationParameters' is null or whitespace.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenNoExpirationException">If <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/> is not null and expirationTime.HasValue is false. When a TokenReplayCache is set, tokens require an expiration time.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayDetectedException">If the 'securityToken' is found in the cache.</exception>
- <exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenReplayAddFailedException">If the 'securityToken' could not be added to the <see cref="P:Microsoft.IdentityModel.Tokens.TokenValidationParameters.TokenReplayCache"/>.</exception>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials">
- <summary>
- An <see cref="T:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials"/> designed to construct <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> based on a x509 certificate.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
- <summary>
- Designed to construct <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> based on a x509 certificate.
- </summary>
- <param name="certificate">A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/></param>
- <remarks>
- <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.DefaultAsymmetricKeyWrapAlgorithm"/> will be used as the key wrap algorithm
- <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.DefaultSymmetricEncryptionAlgorithm"/> will be used as the data encryption algorithm
- </remarks>
- <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String,System.String)">
- <summary>
- Designed to construct <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> based on the x509 certificate, a key wrap algorithm, and data encryption algorithm.
- </summary>
- <param name="certificate">A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/></param>
- <param name="keyWrapAlgorithm">A key wrap algorithm</param>
- <param name="dataEncryptionAlgorithm">Data encryption algorithm</param>
- <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'keyWrapAlgorithm' is null or empty.</exception>
- <exception cref="T:System.ArgumentNullException">if 'dataEncryptionAlgorithm' is null or empty.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509EncryptingCredentials.Certificate">
- <summary>
- Gets the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> used by this instance.
- </summary>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.X509SecurityKey">
- <summary>
- An <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> that is backed by a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
- <summary>
- Instantiates a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> using a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>
- </summary>
- <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to use.</param>
- <exception cref="T:System.ArgumentNullException">if <paramref name="certificate"/> is null.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)">
- <summary>
- Instantiates a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/> using a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>.
- </summary>
- <param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> to use.</param>
- <param name="keyId">The value to set for the KeyId</param>
- <exception cref="T:System.ArgumentNullException">if <paramref name="certificate"/> is null.</exception>
- <exception cref="T:System.ArgumentNullException">if <paramref name="keyId"/> is null or empty.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.KeySize">
- <summary>
- Gets the key size.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.X5t">
- <summary>
- Gets the X5t of this <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKey">
- <summary>
- Returns the private key from the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PublicKey">
- <summary>
- Gets the public key from the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey"/>.
- </summary>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.HasPrivateKey">
- <summary>
- Gets a bool indicating if a private key exists.
- </summary>
- <return>true if it has a private key; otherwise, false.</return>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKeyStatus">
- <summary>
- Gets an enum indicating if a private key exists.
- </summary>
- <return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.Certificate">
- <summary>
- Gets the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.Equals(System.Object)">
- <summary>
- Returns a bool indicating if this key is equivalent to another key.
- </summary>
- <return>true if the keys are equal; otherwise, false.</return>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.GetHashCode">
- <summary>
- Returns an int hash code.
- </summary>
- <return>An int hash code</return>
- </member>
- <member name="T:Microsoft.IdentityModel.Tokens.X509SigningCredentials">
- <summary>
- Defines the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/>, algorithm and digest for digital signatures.
- </summary>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.X509SigningCredentials"/> class.
- </summary>
- <param name="certificate"><see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param>
- <remarks>Algorithm will be set to <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/>.
- the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks>
- <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception>
- </member>
- <member name="M:Microsoft.IdentityModel.Tokens.X509SigningCredentials.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.X509SigningCredentials"/> class.
- </summary>
- <param name="certificate">A <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> that will be used for signing.</param>
- <param name="algorithm">The signature algorithm to apply.</param>
- <remarks>the 'digest method' if needed may be implied from the algorithm. For example <see cref="F:Microsoft.IdentityModel.Tokens.SecurityAlgorithms.RsaSha256"/> implies Sha256.</remarks>
- <exception cref="T:System.ArgumentNullException">if 'certificate' is null.</exception>
- <exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception>
- </member>
- <member name="P:Microsoft.IdentityModel.Tokens.X509SigningCredentials.Certificate">
- <summary>
- Gets the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2"/> used by this instance.
- </summary>
- </member>
- </members>
- </doc>
|