1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144 |
- [[migration]]
- = Migrating to 6.0
- The Spring Security team has prepared the 5.8 release to simplify upgrading to Spring Security 6.0.
- Use 5.8 and the steps below to minimize changes when
- ifdef::spring-security-version[]
- xref:6.0.0@migration.adoc[updating to 6.0]
- endif::[]
- ifndef::spring-security-version[]
- updating to 6.0
- endif::[]
- .
- == Update to Spring Security 5.8
- The first step is to ensure you are the latest patch release of Spring Boot 2.7.
- Next, you should ensure you are on the latest patch release of Spring Security 5.8.
- If you are using Spring Boot, you will need to override the Spring Boot version from Spring Security 5.7 to 5.8.
- Spring Security 5.8 is fully compatible with Spring Security 5.7 and thus Spring Boot 2.7.
- For directions, on how to update to Spring Security 5.8 visit the xref::getting-spring-security.adoc[] section of the reference guide.
- == Servlet
- === Explicit SessionAuthenticationStrategy
- In Spring Security 5, the default configuration relies on `SessionManagementFilter` to detect if a user just authenticated and invoke the `SessionAuthenticationStrategy`.
- The problem with this is that it means that in a typical setup, the `HttpSession` must be read for every request.
- In Spring Security 6, the default is that authentication mechanisms themselves must invoke the `SessionAuthenticationStrategy`.
- This means that there is no need to detect when `Authentication` is done and thus the `HttpSession` does not need to be read for every request.
- To opt into the new Spring Security 6 default, the following configuration can be used.
- .Require Explicit `SessionAuthenticationStrategy` Invocation
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- DefaultSecurityFilterChain springSecurity(HttpSecurity http) throws Exception {
- http
- // ...
- .sessionManagement((sessions) -> sessions
- .requireExplicitAuthenticationStrategy(true)
- );
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- open fun springSecurity(http: HttpSecurity): SecurityFilterChain {
- http {
- sessionManagement {
- requireExplicitAuthenticationStrategy = true
- }
- }
- return http.build()
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <session-management authentication-strategy-explicit-invocation="true"/>
- </http>
- ----
- ====
- If this breaks your application, then you can explicitly opt into the 5.8 defaults using the following configuration:
- .Explicit use Spring Security 5.8 defaults for `SessionAuthenticationStrategy`
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- DefaultSecurityFilterChain springSecurity(HttpSecurity http) throws Exception {
- http
- // ...
- .sessionManagement((sessions) -> sessions
- .requireExplicitAuthenticationStrategy(false)
- );
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- open fun springSecurity(http: HttpSecurity): SecurityFilterChain {
- http {
- sessionManagement {
- requireExplicitAuthenticationStrategy = false
- }
- }
- return http.build()
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <session-management authentication-strategy-explicit-invocation="false"/>
- </http>
- ----
- ====
- === Defer Loading CsrfToken
- In Spring Security 5, the default behavior is that the `CsrfToken` will be loaded on every request.
- This means that in a typical setup, the `HttpSession` must be read for every request even if it is unnecessary.
- In Spring Security 6, the default is that the lookup of the `CsrfToken` will be deferred until it is needed.
- To opt into the new Spring Security 6 default, the following configuration can be used.
- .Defer Loading `CsrfToken`
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- DefaultSecurityFilterChain springSecurity(HttpSecurity http) throws Exception {
- CsrfTokenRequestAttributeHandler requestHandler = new CsrfTokenRequestAttributeHandler();
- // set the name of the attribute the CsrfToken will be populated on
- requestHandler.setCsrfRequestAttributeName("_csrf");
- http
- // ...
- .csrf((csrf) -> csrf
- .csrfTokenRequestHandler(requestHandler)
- );
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- open fun springSecurity(http: HttpSecurity): SecurityFilterChain {
- val requestHandler = CsrfTokenRequestAttributeHandler()
- // set the name of the attribute the CsrfToken will be populated on
- requestHandler.setCsrfRequestAttributeName("_csrf")
- http {
- csrf {
- csrfTokenRequestHandler = requestHandler
- }
- }
- return http.build()
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <csrf request-handler-ref="requestHandler"/>
- </http>
- <b:bean id="requestHandler"
- class="org.springframework.security.web.csrf.CsrfTokenRequestAttributeHandler"
- p:csrfRequestAttributeName="_csrf"/>
- ----
- ====
- If this breaks your application, then you can explicitly opt into the 5.8 defaults using the following configuration:
- .Explicit Configure `CsrfToken` with 5.8 Defaults
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- DefaultSecurityFilterChain springSecurity(HttpSecurity http) throws Exception {
- CsrfTokenRequestAttributeHandler requestHandler = new CsrfTokenRequestAttributeHandler();
- // set the name of the attribute the CsrfToken will be populated on
- requestHandler.setCsrfRequestAttributeName(null);
- http
- // ...
- .csrf((csrf) -> csrf
- .csrfTokenRequestHandler(requestHandler)
- );
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- open fun springSecurity(http: HttpSecurity): SecurityFilterChain {
- val requestHandler = CsrfTokenRequestAttributeHandler()
- // set the name of the attribute the CsrfToken will be populated on
- requestHandler.setCsrfRequestAttributeName(null)
- http {
- csrf {
- csrfTokenRequestHandler = requestHandler
- }
- }
- return http.build()
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <csrf request-handler-ref="requestHandler"/>
- </http>
- <b:bean id="requestHandler"
- class="org.springframework.security.web.csrf.CsrfTokenRequestAttributeHandler">
- <b:property name="csrfRequestAttributeName">
- <b:null/>
- </b:property>
- </b:bean>
- ----
- ====
- === CSRF BREACH Protection
- If the steps for <<Defer Loading CsrfToken>> work for you, then you can also opt into Spring Security 6's default support for BREACH protection of the `CsrfToken` using the following configuration:
- .`CsrfToken` BREACH Protection
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- DefaultSecurityFilterChain springSecurity(HttpSecurity http) throws Exception {
- XorCsrfTokenRequestAttributeHandler requestHandler = new XorCsrfTokenRequestAttributeHandler();
- // set the name of the attribute the CsrfToken will be populated on
- requestHandler.setCsrfRequestAttributeName("_csrf");
- http
- // ...
- .csrf((csrf) -> csrf
- .csrfTokenRequestHandler(requestHandler)
- );
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- open fun springSecurity(http: HttpSecurity): SecurityFilterChain {
- val requestHandler = XorCsrfTokenRequestAttributeHandler()
- // set the name of the attribute the CsrfToken will be populated on
- requestHandler.setCsrfRequestAttributeName("_csrf")
- http {
- csrf {
- csrfTokenRequestHandler = requestHandler
- }
- }
- return http.build()
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <!-- ... -->
- <csrf request-handler-ref="requestHandler"/>
- </http>
- <b:bean id="requestHandler"
- class="org.springframework.security.web.csrf.XorCsrfTokenRequestAttributeHandler"
- p:csrfRequestAttributeName="_csrf"/>
- ----
- ====
- === Explicit Save SecurityContextRepository
- In Spring Security 5, the default behavior is for the xref:servlet/authentication/architecture.adoc#servlet-authentication-securitycontext[`SecurityContext`] to automatically be saved to the xref:servlet/authentication/persistence.adoc#securitycontextrepository[`SecurityContextRepository`] using the xref:servlet/authentication/persistence.adoc#securitycontextpersistencefilter[`SecurityContextPersistenceFilter`].
- Saving must be done just prior to the `HttpServletResponse` being committed and just before `SecurityContextPersistenceFilter`.
- Unfortunately, automatic persistence of the `SecurityContext` can surprise users when it is done prior to the request completing (i.e. just prior to committing the `HttpServletResponse`).
- It also is complex to keep track of the state to determine if a save is necessary causing unnecessary writes to the `SecurityContextRepository` (i.e. `HttpSession`) at times.
- In Spring Security 6, the default behavior is that the xref:servlet/authentication/persistence.adoc#securitycontextholderfilter[`SecurityContextHolderFilter`] will only read the `SecurityContext` from `SecurityContextRepository` and populate it in the `SecurityContextHolder`.
- Users now must explicitly save the `SecurityContext` with the `SecurityContextRepository` if they want the `SecurityContext` to persist between requests.
- This removes ambiguity and improves performance by only requiring writing to the `SecurityContextRepository` (i.e. `HttpSession`) when it is necessary.
- To opt into the new Spring Security 6 default, the following configuration can be used.
- include::partial$servlet/architecture/security-context-explicit.adoc[]
- === Multiple SecurityContextRepository
- In Spring Security 5, the default xref:servlet/authentication/persistence.adoc#securitycontextrepository[`SecurityContextRepository`] is `HttpSessionSecurityContextRepository`.
- In Spring Security 6, the default `SecurityContextRepository` is `DelegatingSecurityContextRepository`.
- To opt into the new Spring Security 6 default, the following configuration can be used.
- .Configure SecurityContextRepository with 6.0 defaults
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .securityContext((securityContext) -> securityContext
- .securityContextRepository(new DelegatingSecurityContextRepository(
- new RequestAttributeSecurityContextRepository(),
- new HttpSessionSecurityContextRepository()
- ))
- );
- return http.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- securityContext {
- securityContextRepository = DelegatingSecurityContextRepository(
- RequestAttributeSecurityContextRepository(),
- HttpSessionSecurityContextRepository()
- )
- }
- }
- return http.build()
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http security-context-repository-ref="contextRepository">
- <!-- ... -->
- </http>
- <bean name="contextRepository"
- class="org.springframework.security.web.context.DelegatingSecurityContextRepository">
- <constructor-arg>
- <bean class="org.springframework.security.web.context.RequestAttributeSecurityContextRepository" />
- </constructor-arg>
- <constructor-arg>
- <bean class="org.springframework.security.web.context.HttpSessionSecurityContextRepository" />
- </constructor-arg>
- </bean>
- ----
- ====
- [IMPORTANT]
- ====
- If you are already using an implementation other than `HttpSessionSecurityContextRepository`, you should replace it with your chosen implementation in the example above to ensure that it is used along with `RequestAttributeSecurityContextRepository`.
- ====
- === Deprecation in SecurityContextRepository
- In Spring Security 5.7, a new method was added to xref:servlet/authentication/persistence.adoc#securitycontextrepository[`SecurityContextRepository`] with the signature:
- Supplier<SecurityContext> loadContext(HttpServletRequest request)
- With the addition of xref:servlet/authentication/persistence.adoc#delegatingsecuritycontextrepository[`DelegatingSecurityContextRepository`] in Spring Security 5.8, that method was deprecated in favor of a new method with the signature:
- DeferredSecurityContext loadDeferredContext(HttpServletRequest request)
- In Spring Security 6, the deprecated method was removed.
- If you have implemented `SecurityContextRepository` yourself and added an implementation of the `loadContext(request)` method, you can prepare for Spring Security 6 by removing the implementation of that method and implementing the new method instead.
- To get started implementing the new method, use the following example to provide a `DeferredSecurityContext`:
- .Provide `DeferredSecurityContext`
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Override
- public DeferredSecurityContext loadDeferredContext(HttpServletRequest request) {
- return new DeferredSecurityContext() {
- private SecurityContext securityContext;
- private boolean isGenerated;
- @Override
- public SecurityContext get() {
- if (this.securityContext == null) {
- this.securityContext = getContextOrNull(request);
- if (this.securityContext == null) {
- SecurityContextHolderStrategy strategy = SecurityContextHolder.getContextHolderStrategy();
- this.securityContext = strategy.createEmptyContext();
- this.isGenerated = true;
- }
- }
- return this.securityContext;
- }
- @Override
- public boolean isGenerated() {
- get();
- return this.isGenerated;
- }
- };
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- override fun loadDeferredContext(request: HttpServletRequest): DeferredSecurityContext {
- return object : DeferredSecurityContext {
- private var securityContext: SecurityContext? = null
- private var isGenerated = false
- override fun get(): SecurityContext {
- if (securityContext == null) {
- securityContext = getContextOrNull(request)
- ?: SecurityContextHolder.getContextHolderStrategy().createEmptyContext()
- .also { isGenerated = true }
- }
- return securityContext!!
- }
- override fun isGenerated(): Boolean {
- get()
- return isGenerated
- }
- }
- }
- ----
- ====
- [[requestcache-query-optimization]]
- === Optimize Querying of `RequestCache`
- In Spring Security 5, the default behavior is to query the xref:servlet/architecture.adoc#savedrequests[saved request] on every request.
- This means that in a typical setup, that in order to use the xref:servlet/architecture.adoc#requestcache[`RequestCache`] the `HttpSession` is queried on every request.
- In Spring Security 6, the default is that `RequestCache` will only be queried for a cached request if the HTTP parameter `continue` is defined.
- This allows Spring Security to avoid unnecessarily reading the `HttpSession` with the `RequestCache`.
- In Spring Security 5 the default is to use `HttpSessionRequestCache` which will be queried for a cached request on every request.
- If you are not overriding the defaults (i.e. using `NullRequestCache`), then the following configuration can be used to explicitly opt into the Spring Security 6 behavior in Spring Security 5.8:
- include::partial$servlet/architecture/request-cache-continue.adoc[]
- === Use `AuthorizationManager` for Method Security
- xref:servlet/authorization/method-security.adoc[Method Security] has been xref:servlet/authorization/method-security.adoc#jc-enable-method-security[simplified] through {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[the `AuthorizationManager` API] and direct use of Spring AOP.
- Should you run into trouble with making these changes, note that `@EnableGlobalMethodSecurity`, while deprecated, will not be removed in 6.0, allowing you to opt out by sticking with the old annotation.
- [[servlet-replace-globalmethodsecurity-with-methodsecurity]]
- ==== Replace xref:servlet/authorization/method-security.adoc#jc-enable-global-method-security[global method security] with xref:servlet/authorization/method-security.adoc#jc-enable-method-security[method security]
- {security-api-url}org/springframework/security/config/annotation/method/configuration/EnableGlobalMethodSecurity.html[`@EnableGlobalMethodSecurity`] and xref:servlet/appendix/namespace/method-security.adoc#nsa-global-method-security[`<global-method-security>`] are deprecated in favor of {security-api-url}org/springframework/security/config/annotation/method/configuration/EnableMethodSecurity.html[`@EnableMethodSecurity`] and xref:servlet/appendix/namespace/method-security.adoc#nsa-method-security[`<method-security>`], respectively.
- The new annotation and XML element activate Spring's xref:servlet/authorization/method-security.adoc#jc-enable-method-security[pre-post annotations] by default and use `AuthorizationManager` internally.
- This means that the following two listings are functionally equivalent:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableGlobalMethodSecurity(prePostEnabled = true)
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableGlobalMethodSecurity(prePostEnabled = true)
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <global-method-security pre-post-enabled="true"/>
- ----
- ====
- and:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableMethodSecurity
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableMethodSecurity
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <method-security/>
- ----
- ====
- For applications not using the pre-post annotations, make sure to turn it off to avoid activating unwanted behavior.
- For example, a listing like:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableGlobalMethodSecurity(securedEnabled = true)
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableGlobalMethodSecurity(securedEnabled = true)
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <global-method-security secured-enabled="true"/>
- ----
- ====
- should change to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableMethodSecurity(securedEnabled = true, prePostEnabled = false)
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableMethodSecurity(securedEnabled = true, prePostEnabled = false)
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <method-security secured-enabled="true" pre-post-enabled="false"/>
- ----
- ====
- [[servlet-replace-permissionevaluator-bean-with-methodsecurityexpression-handler]]
- ==== Publish a `MethodSecurityExpressionHandler` instead of a `PermissionEvaluator`
- `@EnableMethodSecurity` does not pick up a `PermissionEvaluator`.
- This helps keep its API simple.
- If you have a custom {security-api-url}org/springframework/security/access/PermissionEvaluator.html[`PermissionEvaluator`] `@Bean`, please change it from:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- static PermissionEvaluator permissionEvaluator() {
- // ... your evaluator
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- companion object {
- @Bean
- fun permissionEvaluator(): PermissionEvaluator {
- // ... your evaluator
- }
- }
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- static MethodSecurityExpressionHandler expressionHandler() {
- var expressionHandler = new DefaultMethodSecurityExpressionHandler();
- expressionHandler.setPermissionEvaluator(myPermissionEvaluator);
- return expressionHandler;
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- companion object {
- @Bean
- fun expressionHandler(): MethodSecurityExpressionHandler {
- val expressionHandler = DefaultMethodSecurityExpressionHandler
- expressionHandler.setPermissionEvaluator(myPermissionEvaluator)
- return expressionHandler
- }
- }
- ----
- ====
- ==== Replace any custom method-security ``AccessDecisionManager``s
- Your application may have a custom {security-api-url}org/springframework/security/access/AccessDecisionManager.html[`AccessDecisionManager`] or {security-api-url}org/springframework/security/access/AccessDecisionVoter.html[`AccessDecisionVoter`] arrangement.
- The preparation strategy will depend on your reason for each arrangement.
- Read on to find the best match for your situation.
- ===== I use `UnanimousBased`
- If your application uses {security-api-url}org/springframework/security/access/vote/UnanimousBased.html[`UnanimousBased`] with the default voters, you likely need do nothing since unanimous-based is the default behavior with {security-api-url}org/springframework/security/config/annotation/method/configuration/EnableMethodSecurity.html[`@EnableMethodSecurity`].
- However, if you do discover that you cannot accept the default authorization managers, you can use `AuthorizationManagers.allOf` to compose your own arrangement.
- Having done that, please follow the details in the reference manual for xref:servlet/authorization/method-security.adoc#jc-method-security-custom-authorization-manager[adding a custom `AuthorizationManager`].
- ===== I use `AffirmativeBased`
- If your application uses {security-api-url}org/springframework/security/access/vote/AffirmativeBased.html[`AffirmativeBased`], then you can construct an equivalent {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`], like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- AuthorizationManager<MethodInvocation> authorization = AuthorizationManagers.anyOf(
- // ... your list of authorization managers
- )
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val authorization = AuthorizationManagers.anyOf(
- // ... your list of authorization managers
- )
- ----
- ====
- Once you have implemented `AuthorizationManager`, please follow the details in the reference manual for xref:servlet/authorization/method-security.adoc#jc-method-security-custom-authorization-manager[adding a custom `AuthorizationManager`].
- ===== I use `ConsensusBased`
- There is no framework-provided equivalent for {security-api-url}org/springframework/security/access/vote/ConsensusBased.html[`ConsensusBased`].
- In that case, please implement a composite {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`] that takes the set of delegate ``AuthorizationManager``s into account.
- Once you have implemented `AuthorizationManager`, please follow the details in the reference manual for xref:servlet/authorization/method-security.adoc#jc-method-security-custom-authorization-manager[adding a custom `AuthorizationManager`].
- ===== I use a custom `AccessDecisionVoter`
- You should either change the class to implement {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`] or create an adapter.
- Without knowing what your custom voter is doing, it is impossible to recommend a general-purpose solution.
- By way of example, though, here is what adapting {security-api-url}org/springframework/security/access/SecurityMetadataSource.html[`SecurityMetadataSource`] and {security-api-url}org/springframework/security/access/AccessDecisionVoter.html[`AccessDecisionVoter`] for `@PreAuthorize` would look like:
- ====
- .Java
- [source,java,role="primary"]
- ----
- public final class PreAuthorizeAuthorizationManagerAdapter implements AuthorizationManager<MethodInvocation> {
- private final SecurityMetadataSource metadata;
- private final AccessDecisionVoter voter;
- public PreAuthorizeAuthorizationManagerAdapter(MethodSecurityExpressionHandler expressionHandler) {
- ExpressionBasedAnnotationAttributeFactory attributeFactory =
- new ExpressionBasedAnnotationAttributeFactory(expressionHandler);
- this.metadata = new PrePostAnnotationSecurityMetadataSource(attributeFactory);
- ExpressionBasedPreInvocationAdvice expressionAdvice = new ExpressionBasedPreInvocationAdvice();
- expressionAdvice.setExpressionHandler(expressionHandler);
- this.voter = new PreInvocationAuthorizationAdviceVoter(expressionAdvice);
- }
- public AuthorizationDecision check(Supplier<Authentication> authentication, MethodInvocation invocation) {
- List<ConfigAttribute> attributes = this.metadata.getAttributes(invocation, AopUtils.getTargetClass(invocation.getThis()));
- int decision = this.voter.vote(authentication.get(), invocation, attributes);
- if (decision == ACCESS_GRANTED) {
- return new AuthorizationDecision(true);
- }
- if (decision == ACCESS_DENIED) {
- return new AuthorizationDecision(false);
- }
- return null; // abstain
- }
- }
- ----
- ====
- Once you have implemented `AuthorizationManager`, please follow the details in the reference manual for xref:servlet/authorization/method-security.adoc#jc-method-security-custom-authorization-manager[adding a custom `AuthorizationManager`].
- ===== I use a custom `AfterInvocationManager`
- {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`] replaces both {security-api-url}org/springframework/security/access/AccessDecisionManager.html[`AccessDecisionManager`] and {security-api-url}org/springframework/security/access/intercept/AfterInvocationManager.html[`AfterInvocationManager`].
- The difference is that `AuthorizationManager<MethodInvocation>` replaces `AccessDecisionManager` and `AuthorizationManager<MethodInvocationResult>` replaces `AfterInvocationManager`.
- Given that, <<_i_use_a_custom_accessdecisionvoter,the same rules apply for adaptation>>, where the goal this time is to implement `AuthorizationManager<MethodInvocationResult>` instead of `AuthorizationManager<MethodInvocation>` and use `AuthorizationManagerAfterMethodInterceptor` instead of `AuthorizationManagerBeforeMethodInterceptor`.
- ===== I use `RunAsManager`
- There is currently https://github.com/spring-projects/spring-security/issues/11331[no replacement for `RunAsManager`] though one is being considered.
- It is quite straightforward to adapt a `RunAsManager`, though, to the `AuthorizationManager` API, if needed.
- Here is some pseudocode to get you started:
- ====
- .Java
- [source,java,role="primary"]
- ----
- public final class RunAsAuthorizationManagerAdapter<T> implements AuthorizationManager<T> {
- private final RunAsManager runAs = new RunAsManagerImpl();
- private final SecurityMetadataSource metadata;
- private final AuthorizationManager<T> authorization;
- // ... constructor
- public AuthorizationDecision check(Supplier<Authentication> authentication, T object) {
- Supplier<Authentication> wrapped = (auth) -> {
- List<ConfigAttribute> attributes = this.metadata.getAttributes(object);
- return this.runAs.buildRunAs(auth, object, attributes);
- };
- return this.authorization.check(wrapped, object);
- }
- }
- ----
- ====
- Once you have implemented `AuthorizationManager`, please follow the details in the reference manual for xref:servlet/authorization/method-security.adoc#jc-method-security-custom-authorization-manager[adding a custom `AuthorizationManager`].
- [[servlet-check-for-annotationconfigurationexceptions]]
- ==== Check for ``AnnotationConfigurationException``s
- `@EnableMethodSecurity` and `<method-security>` activate stricter enforcement of Spring Security's non-repeatable or otherwise incompatible annotations.
- If after moving to either you see ``AnnotationConfigurationException``s in your logs, follow the instructions in the exception message to clean up your application's method security annotation usage.
- === Use `AuthorizationManager` for Message Security
- xref:servlet/integrations/websocket.adoc[Message Security] has been xref:servlet/integrations/websocket.adoc#websocket-configuration[improved] through {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[the `AuthorizationManager` API] and direct use of Spring AOP.
- Should you run into trouble with making these changes, you can follow the <<servlet-authorizationmanager-messages-opt-out,opt out steps>> at the end of this section.
- ==== Ensure all messages have defined authorization rules
- The now-deprecated {security-api-url}org/springframework/security/config/annotation/web/socket/AbstractSecurityWebSocketMessageBrokerConfigurer.html[message security support] permits all messages by default.
- xref:servlet/integrations/websocket.adoc[The new support] has the stronger default of denying all messages.
- To prepare for this, ensure that authorization rules exist are declared for every request.
- For example, an application configuration like:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Override
- protected void configureInbound(MessageSecurityMetadataSourceRegistry messages) {
- messages
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN");
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- override fun configureInbound(messages: MessageSecurityMetadataSourceRegistry) {
- messages
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <websocket-message-broker>
- <intercept-message pattern="/user/queue/errors" access="permitAll"/>
- <intercept-message pattern="/admin/**" access="hasRole('ADMIN')"/>
- </websocket-message-broker>
- ----
- ====
- should change to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Override
- protected void configureInbound(MessageSecurityMetadataSourceRegistry messages) {
- messages
- .simpTypeMatchers(CONNECT, DISCONNECT, UNSUBSCRIBE).permitAll()
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- .anyMessage().denyAll();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- override fun configureInbound(messages: MessageSecurityMetadataSourceRegistry) {
- messages
- .simpTypeMatchers(CONNECT, DISCONNECT, UNSUBSCRIBE).permitAll()
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- .anyMessage().denyAll()
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <websocket-message-broker>
- <intercept-message type="CONNECT" access="permitAll"/>
- <intercept-message type="DISCONNECT" access="permitAll"/>
- <intercept-message type="UNSUBSCRIBE" access="permitAll"/>
- <intercept-message pattern="/user/queue/errors" access="permitAll"/>
- <intercept-message pattern="/admin/**" access="hasRole('ADMIN')"/>
- <intercept-message pattern="/**" access="denyAll"/>
- </websocket-message-broker>
- ----
- ====
- ==== Add `@EnableWebSocketSecurity`
- [NOTE]
- ====
- If you want to have CSRF disabled and you are using Java configuration, the migration steps are slightly different.
- Instead of using `@EnableWebSocketSecurity`, you will override the appropriate methods in `WebSocketMessageBrokerConfigurer` yourself.
- Please see xref:servlet/integrations/websocket.adoc#websocket-sameorigin-disable[the reference manual] for details about this step.
- ====
- If you are using Java Configuration, add {security-api-url}org/springframework/security/config/annotation/web/socket/EnableWebSocketSecurity.html[`@EnableWebSocketSecurity`] to your application.
- For example, you can add it to your websocket security configuration class, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableWebSocketSecurity
- @Configuration
- public class WebSocketSecurityConfig extends AbstractSecurityWebSocketMessageBrokerConfigurer {
- // ...
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableWebSocketSecurity
- @Configuration
- class WebSocketSecurityConfig: AbstractSecurityWebSocketMessageBrokerConfigurer() {
- // ...
- }
- ----
- ====
- This will make a prototype instance of `MessageMatcherDelegatingAuthorizationManager.Builder` available to encourage configuration by composition instead of extension.
- ==== Use an `AuthorizationManager<Message<?>>` instance
- To start using `AuthorizationManager`, you can set the `use-authorization-manager` attribute in XML or you can publish an `AuthorizationManager<Message<?>>` `@Bean` in Java.
- For example, the following application configuration:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Override
- protected void configureInbound(MessageSecurityMetadataSourceRegistry messages) {
- messages
- .simpTypeMatchers(CONNECT, DISCONNECT, UNSUBSCRIBE).permitAll()
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- .anyMessage().denyAll();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- override fun configureInbound(messages: MessageSecurityMetadataSourceRegistry) {
- messages
- .simpTypeMatchers(CONNECT, DISCONNECT, UNSUBSCRIBE).permitAll()
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- .anyMessage().denyAll()
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <websocket-message-broker>
- <intercept-message type="CONNECT" access="permitAll"/>
- <intercept-message type="DISCONNECT" access="permitAll"/>
- <intercept-message type="UNSUBSCRIBE" access="permitAll"/>
- <intercept-message pattern="/user/queue/errors" access="permitAll"/>
- <intercept-message pattern="/admin/**" access="hasRole('ADMIN')"/>
- <intercept-message pattern="/**" access="denyAll"/>
- </websocket-message-broker>
- ----
- ====
- changes to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- AuthorizationManager<Message<?>> messageSecurity(MessageMatcherDelegatingAuthorizationManager.Builder messages) {
- messages
- .simpTypeMatchers(CONNECT, DISCONNECT, UNSUBSCRIBE).permitAll()
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- .anyMessage().denyAll();
- return messages.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun messageSecurity(val messages: MessageMatcherDelegatingAuthorizationManager.Builder): AuthorizationManager<Message<?>> {
- messages
- .simpTypeMatchers(CONNECT, DISCONNECT, UNSUBSCRIBE).permitAll()
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- .anyMessage().denyAll()
- return messages.build()
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <websocket-message-broker use-authorization-manager="true">
- <intercept-message type="CONNECT" access="permitAll"/>
- <intercept-message type="DISCONNECT" access="permitAll"/>
- <intercept-message type="UNSUBSCRIBE" access="permitAll"/>
- <intercept-message pattern="/user/queue/errors" access="permitAll"/>
- <intercept-message pattern="/admin/**" access="hasRole('ADMIN')"/>
- <intercept-message pattern="/**" access="denyAll"/>
- </websocket-message-broker>
- ----
- ====
- ==== Stop Implementing `AbstractSecurityWebSocketMessageBrokerConfigurer`
- If you are using Java configuration, you can now simply extend `WebSocketMessageBrokerConfigurer`.
- For example, if your class that extends `AbstractSecurityWebSocketMessageBrokerConfigurer` is called `WebSocketSecurityConfig`, then:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableWebSocketSecurity
- @Configuration
- public class WebSocketSecurityConfig extends AbstractSecurityWebSocketMessageBrokerConfigurer {
- // ...
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableWebSocketSecurity
- @Configuration
- class WebSocketSecurityConfig: AbstractSecurityWebSocketMessageBrokerConfigurer() {
- // ...
- }
- ----
- ====
- changes to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableWebSocketSecurity
- @Configuration
- public class WebSocketSecurityConfig implements WebSocketMessageBrokerConfigurer {
- // ...
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableWebSocketSecurity
- @Configuration
- class WebSocketSecurityConfig: WebSocketMessageBrokerConfigurer {
- // ...
- }
- ----
- ====
- [[servlet-authorizationmanager-messages-opt-out]]
- ==== Opt-out Steps
- In case you had trouble, take a look at these scenarios for optimal opt out behavior:
- ===== I cannot declare an authorization rule for all requests
- If you are having trouble setting an `anyRequest` authorization rule of `denyAll`, please use {security-api-url}org/springframework/security/messaging/access/intercept/MessageMatcherDelegatingAuthorizationManager.Builder.Constraint.html#permitAll()[`permitAll`] instead, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- AuthorizationManager<Message<?>> messageSecurity(MessageMatcherDelegatingAuthorizationManager.Builder messages) {
- messages
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- // ...
- .anyMessage().permitAll();
- return messages.build();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun messageSecurity(val messages: MessageMatcherDelegatingAuthorizationManager.Builder): AuthorizationManager<Message<?>> {
- messages
- .simpDestMatchers("/user/queue/errors").permitAll()
- .simpDestMatchers("/admin/**").hasRole("ADMIN")
- // ...
- .anyMessage().permitAll();
- return messages.build()
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <websocket-message-broker use-authorization-manager="true">
- <intercept-message pattern="/user/queue/errors" access="permitAll"/>
- <intercept-message pattern="/admin/**" access="hasRole('ADMIN')"/>
- <!-- ... -->
- <intercept-message pattern="/**" access="permitAll"/>
- </websocket-message-broker>
- ----
- ====
- ===== I cannot get CSRF working, need some other `AbstractSecurityWebSocketMessageBrokerConfigurer` feature, or am having trouble with `AuthorizationManager`
- In the case of Java, you may continue using `AbstractMessageSecurityWebSocketMessageBrokerConfigurer`.
- Even though it is deprecated, it will not be removed in 6.0.
- In the case of XML, you can opt out of `AuthorizationManager` by setting `use-authorization-manager="false"`:
- ====
- .Xml
- [source,xml,role="secondary"]
- ----
- <websocket-message-broker>
- <intercept-message pattern="/user/queue/errors" access="permitAll"/>
- <intercept-message pattern="/admin/**" access="hasRole('ADMIN')"/>
- </websocket-message-broker>
- ----
- ====
- to:
- ====
- .Xml
- [source,xml,role="secondary"]
- ----
- <websocket-message-broker use-authorization-manager="false">
- <intercept-message pattern="/user/queue/errors" access="permitAll"/>
- <intercept-message pattern="/admin/**" access="hasRole('ADMIN')"/>
- </websocket-message-broker>
- ----
- ====
- === Use `AuthorizationManager` for Request Security
- xref:servlet/authorization/authorize-requests.adoc[HTTP Request Security] has been xref:servlet/authorization/authorize-http-requests.adoc[simplified] through {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[the `AuthorizationManager` API].
- Should you run into trouble with making these changes, you can follow the <<servlet-authorizationmanager-requests-opt-out,opt out steps>> at the end of this section.
- ==== Ensure that all requests have defined authorization rules
- In Spring Security 5.8 and earlier, requests with no authorization rule are permitted by default.
- It is a stronger security position to deny by default, thus requiring that authorization rules be clearly defined for every endpoint.
- As such, in 6.0, Spring Security by default denies any request that is missing an authorization rule.
- The simplest way to prepare for this change is to introduce an appropriate {security-api-url}org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.html#anyRequest()[`anyRequest`] rule as the last authorization rule.
- The recommendation is {security-api-url}org/springframework/security/config/annotation/web/configurers/ExpressionUrlAuthorizationConfigurer.AuthorizedUrl.html#denyAll()[`denyAll`] since that is the implied 6.0 default.
- [NOTE]
- ====
- You may already have an `anyRequest` rule defined that you are happy with in which case this step can be skipped.
- ====
- Adding `denyAll` to the end looks like changing:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeRequests((authorize) -> authorize
- .filterSecurityInterceptorOncePerRequest(true)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeRequests {
- filterSecurityInterceptorOncePerRequest = true
- authorize("/app/**", hasRole("APP"))
- // ...
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http once-per-request="true">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- </http>
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeRequests((authorize) -> authorize
- .filterSecurityInterceptorOncePerRequest(true)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeRequests {
- filterSecurityInterceptorOncePerRequest = true
- authorize("/app/**", hasRole("APP"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http once-per-request="true">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- <intercept-url pattern="/**" access="denyAll"/>
- </http>
- ----
- ====
- If you have already migrated to `authorizeHttpRequests`, the recommended change is the same.
- ==== Switch to `AuthorizationManager`
- To opt in to using `AuthorizationManager`, you can use `authorizeHttpRequests` or xref:servlet/appendix/namespace/http.adoc#nsa-http-use-authorization-manager[`use-authorization-manager`] for Java or XML, respectively.
- Change:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeRequests((authorize) -> authorize
- .filterSecurityInterceptorOncePerRequest(true)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeRequests {
- filterSecurityInterceptorOncePerRequest = true
- authorize("/app/**", hasRole("APP"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http once-per-request="true">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- <intercept-url pattern="/**" access="denyAll"/>
- </http>
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize
- .shouldFilterAllDispatcherTypes(false)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- shouldFilterAllDispatcherTypes = false
- authorize("/app/**", hasRole("APP"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http filter-all-dispatcher-types="false" use-authorization-manager="true">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- <intercept-url pattern="/**" access="denyAll"/>
- </http>
- ----
- ====
- ==== Migrate SpEL expressions to `AuthorizationManager`
- For authorization rules, Java tends to be easier to test and maintain than SpEL.
- As such, `authorizeHttpRequests` does not have a method for declaring a `String` SpEL.
- Instead, you can implement your own `AuthorizationManager` implementation or use `WebExpressionAuthorizationManager`.
- For completeness, both options will be demonstrated.
- First, if you have the following SpEL:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeRequests((authorize) -> authorize
- .filterSecurityInterceptorOncePerRequest(true)
- .mvcMatchers("/complicated/**").access("hasRole('ADMIN') || hasAuthority('SCOPE_read')")
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeRequests {
- filterSecurityInterceptorOncePerRequest = true
- authorize("/complicated/**", access("hasRole('ADMIN') || hasAuthority('SCOPE_read')"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- ====
- Then you can compose your own `AuthorizationManager` with Spring Security authorization primitives like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize
- .shouldFilterAllDispatcherTypes(false)
- .mvcMatchers("/complicated/**").access(anyOf(hasRole("ADMIN"), hasAuthority("SCOPE_read"))
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- shouldFilterAllDispatcherTypes = false
- authorize("/complicated/**", access(anyOf(hasRole("ADMIN"), hasAuthority("SCOPE_read"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- ====
- Or you can use `WebExpressionAuthorizationManager` in the following way:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeRequests((authorize) -> authorize
- .filterSecurityInterceptorOncePerRequest(true)
- .mvcMatchers("/complicated/**").access(
- new WebExpressionAuthorizationManager("hasRole('ADMIN') || hasAuthority('SCOPE_read')")
- )
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeRequests {
- filterSecurityInterceptorOncePerRequest = true
- authorize("/complicated/**", access(
- WebExpressionAuthorizationManager("hasRole('ADMIN') || hasAuthority('SCOPE_read')"))
- )
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- ====
- [[switch-filter-all-dispatcher-types]]
- ==== Switch to filter all dispatcher types
- Spring Security 5.8 and earlier only xref:servlet/authorization/architecture.adoc[perform authorization] once per request.
- This means that dispatcher types like `FORWARD` and `INCLUDE` that run after `REQUEST` are not secured by default.
- It's recommended that Spring Security secure all dispatch types.
- As such, in 6.0, Spring Security changes this default.
- So, finally, change your authorization rules to filter all dispatcher types.
- To do this, you should change:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize
- .shouldFilterAllDispatcherTypes(false)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- shouldFilterAllDispatcherTypes = false
- authorize("/app/**", hasRole("APP"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http filter-all-dispatcher-types="false" use-authorization-manager="true">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- <intercept-url pattern="/**" access="denyAll"/>
- </http>
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize
- .shouldFilterAllDispatcherTypes(true)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- shouldFilterAllDispatcherTypes = true
- authorize("/app/**", hasRole("APP"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http filter-all-dispatcher-types="true" use-authorization-manager="true">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- <intercept-url pattern="/**" access="denyAll"/>
- </http>
- ----
- ====
- And, the `FilterChainProxy` should be registered for all dispatcher types as well.
- If you are using Spring Boot, https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#application-properties.security.spring.security.filter.dispatcher-types[you have to change the `spring.security.filter.dispatcher-types` property] to include all dispatcher types:
- ====
- .application.properties
- [source,properties,role="primary"]
- ----
- spring.security.filter.dispatcher-types=request,async,error,forward,include
- ----
- ====
- If you are xref::servlet/configuration/java.adoc#_abstractsecuritywebapplicationinitializer[using the `AbstractSecurityWebApplicationInitializer`] you should override the `getSecurityDispatcherTypes` method and return all dispatcher types:
- ====
- .Java
- [source,java,role="primary"]
- ----
- import org.springframework.security.web.context.*;
- public class SecurityWebApplicationInitializer extends AbstractSecurityWebApplicationInitializer {
- @Override
- protected EnumSet<DispatcherType> getSecurityDispatcherTypes() {
- return EnumSet.of(DispatcherType.REQUEST, DispatcherType.ERROR, DispatcherType.FORWARD,
- DispatcherType.FORWARD, DispatcherType.INCLUDE);
- }
- }
- ----
- ====
- ===== Permit `FORWARD` when using Spring MVC
- If you are using {spring-framework-reference-url}/web.html#mvc-viewresolver[Spring MVC to resolve view names], you will need to permit `FORWARD` requests.
- This is because when Spring MVC detects a mapping between view name and the actual views, it will perform a forward to the view.
- As we saw on the <<switch-filter-all-dispatcher-types,previous section>>, Spring Security 6.0 will apply authorization to `FORWARD` requests by default.
- Consider the following common configuration:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authorize) -> authorize
- .shouldFilterAllDispatcherTypes(true)
- .requestMatchers("/").authenticated()
- .anyRequest().denyAll()
- )
- .formLogin((form) -> form
- .loginPage("/login")
- .permitAll()
- ));
- return http.build();
- }
- ----
- ====
- and one of the following equivalents MVC view mapping configurations:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Controller
- public class MyController {
- @GetMapping("/login")
- public String login() {
- return "login";
- }
- }
- ----
- ====
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class MyWebMvcConfigurer implements WebMvcConfigurer {
- @Override
- public void addViewControllers(ViewControllerRegistry registry) {
- registry.addViewController("/login").setViewName("login");
- }
- }
- ----
- ====
- With either configuration, when there is a request to `/login`, Spring MVC will perform a *forward* to the view `login`, which, with the default configuration, is under `src/main/resources/templates/login.html` path.
- The security configuration permits requests to `/login` but every other request will be denied, including the `FORWARD` request to the view under `/templates/login.html`.
- To fix this, you should configure Spring Security to permit `FORWARD` requests:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize
- .shouldFilterAllDispatcherTypes(true)
- .dispatcherTypeMatchers(DispatcherType.FORWARD).permitAll()
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- shouldFilterAllDispatcherTypes = true
- authorize(DispatcherTypeRequestMatcher(DispatcherType.FORWARD), permitAll)
- authorize(anyRequest, denyAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http filter-all-dispatcher-types="true" use-authorization-manager="true">
- <intercept-url request-matcher-ref="forwardRequestMatcher" access="permitAll()" />
- <!-- ... -->
- <intercept-url pattern="/**" access="denyAll"/>
- </http>
- <bean name="forwardRequestMatcher" class="org.springframework.security.web.util.matcher.DispatcherTypeRequestMatcher">
- <constructor-arg value="FORWARD"/>
- </bean>
- ----
- ====
- ==== Replace any custom filter-security ``AccessDecisionManager``s
- Your application may have a custom {security-api-url}org/springframework/security/access/AccessDecisionManager.html[`AccessDecisionManager`] or {security-api-url}org/springframework/security/access/AccessDecisionVoter.html[`AccessDecisionVoter`] arrangement.
- The preparation strategy will depend on your reason for each arrangement.
- Read on to find the best match for your situation.
- ===== I use `UnanimousBased`
- If your application uses {security-api-url}org/springframework/security/access/vote/UnanimousBased.html[`UnanimousBased`], you should first adapt or replace any ``AccessDecisionVoter``s and then you can construct an `AuthorizationManager` like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- AuthorizationManager<RequestAuthorizationContext> requestAuthorization() {
- PolicyAuthorizationManager policy = ...;
- LocalAuthorizationManager local = ...;
- return AuthorizationMangers.allOf(policy, local);
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun requestAuthorization(): AuthorizationManager<RequestAuthorizationContext> {
- val policy: PolicyAuthorizationManager = ...
- val local: LocalAuthorizationManager = ...
- return AuthorizationMangers.allOf(policy, local)
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <bean id="requestAuthorization" class="org.springframework.security.authorization.AuthorizationManagers"
- factory-method="allOf">
- <constructor-arg>
- <util:list>
- <bean class="my.PolicyAuthorizationManager"/>
- <bean class="my.LocalAuthorizationManager"/>
- </util:list>
- </constructor-arg>
- </bean>
- ----
- ====
- then, wire it into the DSL like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize.anyRequest().access(requestAuthorization))
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- authorize(anyRequest, requestAuthorization)
- }
- // ...
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http authorization-manager-ref="requestAuthorization"/>
- ----
- ====
- [NOTE]
- ====
- `authorizeHttpRequests` is designed so that you can apply a custom `AuthorizationManager` to any url pattern.
- See xref:servlet/authorization/authorize-http-requests.adoc#custom-authorization-manager[the reference] for more details.
- ====
- ===== I use `AffirmativeBased`
- If your application uses {security-api-url}org/springframework/security/access/vote/AffirmativeBased.html[`AffirmativeBased`], then you can construct an equivalent {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`], like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- AuthorizationManager<RequestAuthorizationContext> requestAuthorization() {
- PolicyAuthorizationManager policy = ...;
- LocalAuthorizationManager local = ...;
- return AuthorizationMangers.anyOf(policy, local);
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun requestAuthorization(): AuthorizationManager<RequestAuthorizationContext> {
- val policy: PolicyAuthorizationManager = ...
- val local: LocalAuthorizationManager = ...
- return AuthorizationMangers.anyOf(policy, local)
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <bean id="requestAuthorization" class="org.springframework.security.authorization.AuthorizationManagers"
- factory-method="anyOf">
- <constructor-arg>
- <util:list>
- <bean class="my.PolicyAuthorizationManager"/>
- <bean class="my.LocalAuthorizationManager"/>
- </util:list>
- </constructor-arg>
- </bean>
- ----
- ====
- then, wire it into the DSL like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize.anyRequest().access(requestAuthorization))
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- authorize(anyRequest, requestAuthorization)
- }
- // ...
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http authorization-manager-ref="requestAuthorization"/>
- ----
- ====
- [NOTE]
- ====
- `authorizeHttpRequests` is designed so that you can apply a custom `AuthorizationManager` to any url pattern.
- See xref:servlet/authorization/authorize-http-requests.adoc#custom-authorization-manager[the reference] for more details.
- ====
- ===== I use `ConsensusBased`
- There is no framework-provided equivalent for {security-api-url}org/springframework/security/access/vote/ConsensusBased.html[`ConsensusBased`].
- In that case, please implement a composite {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`] that takes the set of delegate ``AuthorizationManager``s into account.
- Once you have implemented `AuthorizationManager`, please follow the details in the reference manual for xref:servlet/authorization/authorize-http-requests.adoc#custom-authorization-manager[adding a custom `AuthorizationManager`].
- ===== I use a custom `AccessDecisionVoter`
- You should either change the class to implement {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[`AuthorizationManager`] or create an adapter.
- Without knowing what your custom voter is doing, it is impossible to recommend a general-purpose solution.
- By way of example, though, here is what adapting {security-api-url}org/springframework/security/access/SecurityMetadataSource.html[`SecurityMetadataSource`] and {security-api-url}org/springframework/security/access/AccessDecisionVoter.html[`AccessDecisionVoter`] for `anyRequest().authenticated()` would look like:
- ====
- .Java
- [source,java,role="primary"]
- ----
- public final class AnyRequestAuthenticatedAuthorizationManagerAdapter implements AuthorizationManager<RequestAuthorizationContext> {
- private final SecurityMetadataSource metadata;
- private final AccessDecisionVoter voter;
- public PreAuthorizeAuthorizationManagerAdapter(SecurityExpressionHandler expressionHandler) {
- Map<RequestMatcher, List<ConfigAttribute>> requestMap = Collections.singletonMap(
- AnyRequestMatcher.INSTANCE, Collections.singletonList(new SecurityConfig("authenticated")));
- this.metadata = new DefaultFilterInvocationSecurityMetadataSource(requestMap);
- WebExpressionVoter voter = new WebExpressionVoter();
- voter.setExpressionHandler(expressionHandler);
- this.voter = voter;
- }
- public AuthorizationDecision check(Supplier<Authentication> authentication, RequestAuthorizationContext context) {
- List<ConfigAttribute> attributes = this.metadata.getAttributes(context);
- int decision = this.voter.vote(authentication.get(), invocation, attributes);
- if (decision == ACCESS_GRANTED) {
- return new AuthorizationDecision(true);
- }
- if (decision == ACCESS_DENIED) {
- return new AuthorizationDecision(false);
- }
- return null; // abstain
- }
- }
- ----
- ====
- Once you have implemented `AuthorizationManager`, please follow the details in the reference manual for xref:servlet/authorization/authorize-http-requests.adoc#custom-authorization-manager[adding a custom `AuthorizationManager`].
- [[servlet-authorizationmanager-requests-opt-out]]
- ==== Opt-out Steps
- In case you had trouble, take a look at these scenarios for optimal opt out behavior:
- ===== I cannot secure all dispatcher types
- If you cannot secure all dispatcher types, first try and declare which dispatcher types should not require authorization like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize
- .shouldFilterAllDispatcherTypes(true)
- .dispatcherTypeMatchers(FORWARD, INCLUDE).permitAll()
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- .anyRequest().denyAll()
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- shouldFilterAllDispatcherTypes = true
- authorize(DispatcherTypeRequestMatcher(FORWARD, INCLUDE), permitAll)
- authorize("/app/**", hasRole("APP"))
- // ...
- authorize(anyRequest, denyAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http filter-all-dispatcher-types="true" use-authorization-manager="true">
- <intercept-url request-matcher-ref="dispatchers"/>
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- <intercept-url pattern="/**" access="denyAll"/>
- </http>
- <bean id="dispatchers" class="org.springframework.security.web.util.matcher.DispatcherTypeRequestMatcher">
- <constructor-arg>
- <util:list value-type="javax.servlet.DispatcherType">
- <value>FORWARD</value>
- <value>INCLUDE</value>
- </util:list>
- </constructor-arg>
- </bean>
- ----
- ====
- Or, if that doesn't work, then you can explicitly opt out of the behavior by setting `filter-all-dispatcher-types` and `filterAllDispatcherTypes` to `false`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpRequests((authorize) -> authorize
- .filterAllDispatcherTypes(false)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- filterAllDispatcherTypes = false
- authorize("/messages/**", hasRole("APP"))
- // ...
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http filter-all-dispatcher-types="false" use-authorization-manager="true">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- </http>
- ----
- ====
- or, if you are still using `authorizeRequests` or `use-authorization-manager="false"`, set `oncePerRequest` to `true`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeRequests((authorize) -> authorize
- .filterSecurityInterceptorOncePerRequest(true)
- .mvcMatchers("/app/**").hasRole("APP")
- // ...
- )
- // ...
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeRequests {
- filterSecurityInterceptorOncePerRequest = true
- authorize("/messages/**", hasRole("APP"))
- // ...
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http once-per-request="true" use-authorization-manager="false">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- </http>
- ----
- ====
- ===== I cannot declare an authorization rule for all requests
- If you are having trouble setting an `anyRequest` authorization rule of `denyAll`, please use {security-api-url}org/springframework/security/config/annotation/web/configurers/ExpressionUrlAuthorizationConfigurer.AuthorizedUrl.html#permitAll()[`permitAll`] instead, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .authorizeHttpReqeusts((authorize) -> authorize
- .mvcMatchers("/app/*").hasRole("APP")
- // ...
- .anyRequest().permitAll()
- )
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- authorizeHttpRequests {
- authorize("/app*", hasRole("APP"))
- // ...
- authorize(anyRequest, permitAll)
- }
- }
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <http>
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- <intercept-url pattern="/**" access="permitAll"/>
- </http>
- ----
- ====
- ===== I cannot migrate my SpEL or my `AccessDecisionManager`
- If you are having trouble with SpEL, `AccessDecisionManager`, or there is some other feature that you are needing to keep using in `<http>` or `authorizeRequests`, try the following.
- First, if you still need `authorizeRequests`, you are welcome to keep using it. Even though it is deprecated, it is not removed in 6.0.
- Second, if you still need your custom `access-decision-manager-ref` or have some other reason to opt out of `AuthorizationManager`, do:
- ====
- .Xml
- [source,xml,role="secondary"]
- ----
- <http use-authorization-manager="false">
- <intercept-url pattern="/app/*" access="hasRole('APP')"/>
- <!-- ... -->
- </http>
- ----
- ====
- === Propagate ``AuthenticationServiceException``s
- {security-api-url}org/springframework/security/web/authentication/AuthenticationFilter.html[`AuthenticationFilter`] propagates {security-api-url}org/springframework/security/authentication/AuthenticationServiceException.html[``AuthenticationServiceException``]s to the {security-api-url}org/springframework/security/authentication/AuthenticationEntryPoint.html[`AuthenticationEntryPoint`].
- Because ``AuthenticationServiceException``s represent a server-side error instead of a client-side error, in 6.0, this changes to propagate them to the container.
- ==== Configure `AuthenticationFailureHandler` to rethrow ``AuthenticationServiceException``s
- To prepare for the 6.0 default, wire `AuthenticationFilter` instances with a `AuthenticationFailureHandler` that rethrows ``AuthenticationServiceException``s, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- AuthenticationFilter authenticationFilter = new AuthenticationFilter(...);
- AuthenticationEntryPointFailureHandler handler = new AuthenticationEntryPointFailureHandler(...);
- handler.setRethrowAuthenticationServiceException(true);
- authenticationFilter.setAuthenticationFailureHandler(handler);
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val authenticationFilter: AuthenticationFilter = new AuthenticationFilter(...)
- val handler: AuthenticationEntryPointFailureHandler = new AuthenticationEntryPointFailureHandler(...)
- handler.setRethrowAuthenticationServiceException(true)
- authenticationFilter.setAuthenticationFailureHandler(handler)
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <bean id="authenticationFilter" class="org.springframework.security.web.authentication.AuthenticationFilter">
- <!-- ... -->
- <property ref="authenticationFailureHandler"/>
- </bean>
- <bean id="authenticationFailureHandler" class="org.springframework.security.web.authentication.AuthenticationEntryPointFailureHandler">
- <property name="rethrowAuthenticationServiceException" value="true"/>
- </bean>
- ----
- ====
- [[servlet-authenticationfailurehandler-opt-out]]
- ==== Opt-out Steps
- If rethrowing ``AuthenticationServiceException``s gives you trouble, you can set the value to false instead of taking the 6.0 default, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- AuthenticationFilter authenticationFilter = new AuthenticationFilter(...);
- AuthenticationEntryPointFailureHandler handler = new AuthenticationEntryPointFailureHandler(...);
- handler.setRethrowAuthenticationServiceException(false);
- authenticationFilter.setAuthenticationFailureHandler(handler);
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val authenticationFilter: AuthenticationFilter = new AuthenticationFilter(...)
- val handler: AuthenticationEntryPointFailureHandler = new AuthenticationEntryPointFailureHandler(...)
- handler.setRethrowAuthenticationServiceException(false)
- authenticationFilter.setAuthenticationFailureHandler(handler)
- ----
- .Xml
- [source,xml,role="secondary"]
- ----
- <bean id="authenticationFilter" class="org.springframework.security.web.authentication.AuthenticationFilter">
- <!-- ... -->
- <property ref="authenticationFailureHandler"/>
- </bean>
- <bean id="authenticationFailureHandler" class="org.springframework.security.web.authentication.AuthenticationEntryPointFailureHandler">
- <property name="rethrowAuthenticationServiceException" value="false"/>
- </bean>
- ----
- ====
- [[servlet-opt-in-sha256-rememberme]]
- === Use SHA-256 in Remember Me
- The `TokenBasedRememberMeServices` implementation now supports SHA-256 for the Remember Me token and this is the default in Spring Security 6.
- This change makes the implementation more secure by default since MD5 is already proven to be a weak hashing algorithm and vulnerable against collision attacks and modular differential attacks.
- The new generated tokens now have the information of which algorithm was used to generate the token and that information is used in order to match it.
- If the algorithm name is not present, then the `matchingAlgorithm` property is used to check the token.
- This allows for a smooth transition from MD5 to SHA-256.
- To opt into the new Spring Security 6 default to encode the tokens while still being able to decode tokens encoded with MD5, you can set the `encodingAlgorithm` property to SHA-256 and the `matchingAlgorithm` property to MD5.
- See the xref:servlet/authentication/rememberme.adoc#_tokenbasedremembermeservices[reference documentation] and the {security-api-url}org/springframework/security/web/authentication/rememberme/TokenBasedRememberMeServices.html[API docs] for more information.
- [[servlet-opt-in-sha256-sha256-encoding]]
- .Use Spring Security 6 defaults for encoding, SHA-256 for encoding and MD5 for matching
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http, RememberMeServices rememberMeServices) throws Exception {
- http
- // ...
- .rememberMe((remember) -> remember
- .rememberMeServices(rememberMeServices)
- );
- return http.build();
- }
- @Bean
- RememberMeServices rememberMeServices(UserDetailsService userDetailsService) {
- RememberMeTokenAlgorithm encodingAlgorithm = RememberMeTokenAlgorithm.SHA256;
- TokenBasedRememberMeServices rememberMe = new TokenBasedRememberMeServices(myKey, userDetailsService, encodingAlgorithm);
- rememberMe.setMatchingAlgorithm(RememberMeTokenAlgorithm.MD5);
- return rememberMe;
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <remember-me services-ref="rememberMeServices"/>
- </http>
- <bean id="rememberMeServices" class=
- "org.springframework.security.web.authentication.rememberme.TokenBasedRememberMeServices">
- <property name="userDetailsService" ref="myUserDetailsService"/>
- <property name="key" value="springRocks"/>
- <property name="matchingAlgorithm" value="MD5"/>
- <property name="encodingAlgorithm" value="SHA256"/>
- </bean>
- ----
- ====
- At some point, you will want to fully migrate to Spring Security 6 defaults. But how do you know when it is safe to do so?
- Let's suppose that you deployed your application using SHA-256 as the encoding algorithm (as you have done <<servlet-opt-in-sha256-sha256-encoding,here>>) on November 1st, if you have the value for the `tokenValiditySeconds` property set to N days (14 is the default), you can migrate to SHA-256 N days after November 1st (which is November 15th in this example).
- By that time, all the tokens generated with MD5 will have expired.
- .Use Spring Security 6 defaults, SHA-256 for both encoding and matching
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http, RememberMeServices rememberMeServices) throws Exception {
- http
- // ...
- .rememberMe((remember) -> remember
- .rememberMeServices(rememberMeServices)
- );
- return http.build();
- }
- @Bean
- RememberMeServices rememberMeServices(UserDetailsService userDetailsService) {
- RememberMeTokenAlgorithm encodingAlgorithm = RememberMeTokenAlgorithm.SHA256;
- TokenBasedRememberMeServices rememberMe = new TokenBasedRememberMeServices(myKey, userDetailsService, encodingAlgorithm);
- rememberMe.setMatchingAlgorithm(RememberMeTokenAlgorithm.SHA256);
- return rememberMe;
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <remember-me services-ref="rememberMeServices"/>
- </http>
- <bean id="rememberMeServices" class=
- "org.springframework.security.web.authentication.rememberme.TokenBasedRememberMeServices">
- <property name="userDetailsService" ref="myUserDetailsService"/>
- <property name="key" value="springRocks"/>
- <property name="matchingAlgorithm" value="SHA256"/>
- <property name="encodingAlgorithm" value="SHA256"/>
- </bean>
- ----
- ====
- If you are having problems with the Spring Security 6 defaults, you can explicitly opt into 5.8 defaults using the following configuration:
- .Use MD5 for both encoding and matching algorithms
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http, RememberMeServices rememberMeServices) throws Exception {
- http
- // ...
- .rememberMe((remember) -> remember
- .rememberMeServices(rememberMeServices)
- );
- return http.build();
- }
- @Bean
- RememberMeServices rememberMeServices(UserDetailsService userDetailsService) {
- RememberMeTokenAlgorithm encodingAlgorithm = RememberMeTokenAlgorithm.MD5;
- TokenBasedRememberMeServices rememberMe = new TokenBasedRememberMeServices(myKey, userDetailsService, encodingAlgorithm);
- rememberMe.setMatchingAlgorithm(RememberMeTokenAlgorithm.MD5);
- return rememberMe;
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <remember-me services-ref="rememberMeServices"/>
- </http>
- <bean id="rememberMeServices" class=
- "org.springframework.security.web.authentication.rememberme.TokenBasedRememberMeServices">
- <property name="userDetailsService" ref="myUserDetailsService"/>
- <property name="key" value="springRocks"/>
- <property name="matchingAlgorithm" value="MD5"/>
- <property name="encodingAlgorithm" value="MD5"/>
- </bean>
- ----
- ====
- === Stop Using SAML 2.0 `Converter` constructors
- In an early release of Spring Security's SAML 2.0 support, `Saml2MetadataFilter` and `Saml2AuthenticationTokenConverter` shipped with constructors of type `Converter`.
- This level of abstraction made it tricky to evolve the class and so a dedicated interface `RelyingPartyRegistrationResolver` was introduced in a later release.
- In 6.0, the `Converter` constructors are removed.
- To prepare for this in 5.8, change classes that implement `Converter<HttpServletRequest, RelyingPartyRegistration>` to instead implement `RelyingPartyRegistrationResolver`.
- === Change to Using `Saml2AuthenticationRequestResolver`
- `Saml2AuthenticationContextResolver` and `Saml2AuthenticationRequestFactory` are removed in 6.0 as is the `Saml2WebSsoAuthenticationRequestFilter` that requires them.
- They are replaced by `Saml2AuthenticationRequestResolver` and a new constructor in `Saml2WebSsoAuthenticationRequestFilter`.
- The new interface removes an unnecessary transport object between the two classes.
- Most applications need do nothing; however, if you use or configure `Saml2AuthenticationRequestContextResolver` or `Saml2AuthenticationRequestFactory`, try the following steps to convert instead use `Saml2AuthenticationRequestResolver`.
- ==== Use `setAuthnRequestCustomizer` instead of `setAuthenticationRequestContextConverter`
- If you are calling `OpenSaml4AuthenticationReqeustFactory#setAuthenticationRequestContextConverter`, for example, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- Saml2AuthenticationRequestFactory authenticationRequestFactory() {
- OpenSaml4AuthenticationRequestFactory factory = new OpenSaml4AuthenticationRequestFactory();
- factory.setAuthenticationRequestContextConverter((context) -> {
- AuthnRequestBuilder authnRequestBuilder = ConfigurationService.get(XMLObjectProviderRegistry.class)
- .getBuilderFactory().getBuilder(AuthnRequest.DEFAULT_ELEMENT_NAME);
- IssuerBuilder issuerBuilder = ConfigurationService.get(XMLObjectProviderRegistry.class)
- .getBuilderFactory().getBuilder(Issuer.DEFAULT_ELEMENT_NAME);
- tring issuer = context.getIssuer();
- String destination = context.getDestination();
- String assertionConsumerServiceUrl = context.getAssertionConsumerServiceUrl();
- String protocolBinding = context.getRelyingPartyRegistration().getAssertionConsumerServiceBinding().getUrn();
- AuthnRequest auth = authnRequestBuilder.buildObject();
- auth.setID("ARQ" + UUID.randomUUID().toString().substring(1));
- auth.setIssueInstant(Instant.now());
- auth.setForceAuthn(Boolean.TRUE);
- auth.setIsPassive(Boolean.FALSE);
- auth.setProtocolBinding(SAMLConstants.SAML2_POST_BINDING_URI);
- Issuer iss = issuerBuilder.buildObject();
- iss.setValue(issuer);
- auth.setIssuer(iss);
- auth.setDestination(destination);
- auth.setAssertionConsumerServiceURL(assertionConsumerServiceUrl);
- });
- return factory;
- }
- ----
- ====
- to ensure that ForceAuthn is set to `true`, you can instead do:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- Saml2AuthenticationRequestResolver authenticationRequestResolver(RelyingPartyRegistrationResolver registrations) {
- OpenSaml4AuthenticationRequestResolver reaolver = new OpenSaml4AuthenticationRequestResolver(registrations);
- resolver.setAuthnRequestCustomizer((context) -> context.getAuthnRequest().setForceAuthn(Boolean.TRUE));
- return resolver;
- }
- ----
- ====
- Also, since `setAuthnRequestCustomizer` has direct access to the `HttpServletRequest`, there is no need for a `Saml2AuthenticationRequestContextResolver`.
- Simply use `setAuthnRequestCustomizer` to read directly from `HttpServletRequest` this information you need.
- ==== Use `setAuthnRequestCustomizer` instead of `setProtocolBinding`
- Instead of doing:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- Saml2AuthenticationRequestFactory authenticationRequestFactory() {
- OpenSaml4AuthenticationRequestFactory factory = new OpenSaml4AuthenticationRequestFactory();
- factory.setProtocolBinding("urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST")
- return factory;
- }
- ----
- ====
- you can do:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- Saml2AuthenticationRequestResolver authenticationRequestResolver() {
- OpenSaml4AuthenticationRequestResolver reaolver = new OpenSaml4AuthenticationRequestResolver(registrations);
- resolver.setAuthnRequestCustomizer((context) -> context.getAuthnRequest()
- .setProtocolBinding("urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"));
- return resolver;
- }
- ----
- ====
- [NOTE]
- ====
- Since Spring Security only supports the `POST` binding for authentication, there is not very much value in overriding the protocol binding at this point in time.
- ====
- === Use the latest `Saml2AuthenticationToken` constructor
- In an early release, `Saml2AuthenticationToken` took several individual settings as constructor parameters.
- This created a challenge each time a new parameter needed to be added.
- Since most of these settings were part of `RelyingPartyRegistration`, a new constructor was added where a `RelyingPartyRegistration` could be provided, making the constructor more stable.
- It also is valuable in that it more closely aligns with the design of `OAuth2LoginAuthenticationToken`.
- Most applications do not construct this class directly since `Saml2WebSsoAuthenticationFilter` does.
- However, in the event that your application constructs one, please change from:
- ====
- .Java
- [source,java,role="primary"]
- ----
- new Saml2AuthenticationToken(saml2Response, registration.getSingleSignOnServiceLocation(),
- registration.getAssertingParty().getEntityId(), registration.getEntityId(), registration.getCredentials())
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- Saml2AuthenticationToken(saml2Response, registration.getSingleSignOnServiceLocation(),
- registration.getAssertingParty().getEntityId(), registration.getEntityId(), registration.getCredentials())
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- new Saml2AuthenticationToken(saml2Response, registration)
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- Saml2AuthenticationToken(saml2Response, registration)
- ----
- ====
- === Use `RelyingPartyRegistration` updated methods
- In an early release of Spring Security's SAML support, there was some ambiguity on the meaning of certain `RelyingPartyRegistration` methods and their function.
- As more capabilities were added to `RelyingPartyRegistration`, it became necessary to clarify this ambiguity by changing method names to ones that aligned with spec language.
- The deprecated methods in `RelyingPartyRegstration` are removed.
- To prepare for that, consider the following representative usage of `RelyingPartyRegistration`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- String idpEntityId = registration.getRemoteIdpEntityId();
- String assertionConsumerServiceUrl = registration.getAssertionConsumerServiceUrlTemplate();
- String idpWebSsoUrl = registration.getIdpWebSsoUrl();
- String localEntityId = registration.getLocalEntityIdTemplate();
- List<Saml2X509Credential> verifying = registration.getCredentials().stream()
- .filter(Saml2X509Credential::isSignatureVerficationCredential)
- .collect(Collectors.toList());
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val idpEntityId: String = registration.getRemoteIdpEntityId()
- val assertionConsumerServiceUrl: String = registration.getAssertionConsumerServiceUrlTemplate()
- val idpWebSsoUrl: String = registration.getIdpWebSsoUrl()
- val localEntityId: String = registration.getLocalEntityIdTemplate()
- val verifying: List<Saml2X509Credential> = registration.getCredentials()
- .filter(Saml2X509Credential::isSignatureVerficationCredential)
- ----
- ====
- This should change to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- String assertingPartyEntityId = registration.getAssertingPartyDetails().getEntityId();
- String assertionConsumerServiceLocation = registration.getAssertionConsumerServiceLocation();
- String singleSignOnServiceLocation = registration.getAssertingPartyDetails().getSingleSignOnServiceLocation();
- String entityId = registration.getEntityId();
- List<Saml2X509Credential> verifying = registration.getAssertingPartyDetails().getVerificationX509Credentials();
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val assertingPartyEntityId: String = registration.getAssertingPartyDetails().getEntityId()
- val assertionConsumerServiceLocation: String = registration.getAssertionConsumerServiceLocation()
- val singleSignOnServiceLocation: String = registration.getAssertingPartyDetails().getSingleSignOnServiceLocation()
- val entityId: String = registration.getEntityId()
- val verifying: List<Saml2X509Credential> = registration.getAssertingPartyDetails().getVerificationX509Credentials()
- ----
- ====
- For a complete listing of all changed methods, please see {security-api-url}org/springframework/security/saml2/provider/service/registration/RelyingPartyRegistration.html[``RelyingPartyRegistration``'s JavaDoc].
- === Use OpenSAML 4
- OpenSAML 3 has reached its end-of-life.
- As such, Spring Security 6 drops support for it, bumping up its OpenSAML baseline to 4.
- To prepare for the upgrade, update your pom to depend on OpenSAML 4 instead of 3:
- ====
- .Maven
- [source,maven,role="primary"]
- ----
- <dependencyManagement>
- <dependency>
- <groupId>org.opensaml</groupId>
- <artifactId>opensaml-core</artifactId>
- <version>4.2.1</version>
- </dependency>
- <dependency>
- <groupId>org.opensaml</groupId>
- <artifactId>opensaml-saml-api</artifactId>
- <version>4.2.1</version>
- </dependency>
- <dependency>
- <groupId>org.opensaml</groupId>
- <artifactId>opensaml-saml-impl</artifactId>
- <version>4.2.1</version>
- </dependency>
- </dependencyManagement>
- ----
- .Gradle
- [source,gradle,role="secondary"]
- ----
- dependencies {
- constraints {
- api "org.opensaml:opensaml-core:4.2.1"
- api "org.opensaml:opensaml-saml-api:4.2.1"
- api "org.opensaml:opensaml-saml-impl:4.2.1"
- }
- }
- ----
- ====
- You must use at least OpenSAML 4.1.1 to update to Spring Security 6's SAML support.
- === Use `OpenSaml4AuthenticationProvider`
- In order to support both OpenSAML 3 and 4 at the same time, Spring Security released `OpenSamlAuthenticationProvider` and `OpenSaml4AuthenticationProvider`.
- In 6.0, because OpenSAML3 support is removed, `OpenSamlAuthenticationProvider` is removed as well.
- Not all methods in `OpenSamlAuthenticationProvider` were ported 1-to-1 to `OpenSaml4AuthenticationProvider`.
- As such, some adjustment will be required to make the challenge.
- Consider the following representative usage of `OpenSamlAuthenticationProvider`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- OpenSamlAuthenticationProvider versionThree = new OpenSamlAuthenticationProvider();
- versionThree.setAuthoritiesExtractor(myAuthoritiesExtractor);
- versionThree.setResponseTimeValidationSkew(myDuration);
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val versionThree: OpenSamlAuthenticationProvider = OpenSamlAuthenticationProvider()
- versionThree.setAuthoritiesExtractor(myAuthoritiesExtractor)
- versionThree.setResponseTimeValidationSkew(myDuration)
- ----
- ====
- This should change to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- Converter<ResponseToken, Saml2Authentication> delegate = OpenSaml4AuthenticationProvider
- .createDefaultResponseAuthenticationConverter();
- OpenSaml4AuthenticationProvider versionFour = new OpenSaml4AuthenticationProvider();
- versionFour.setResponseAuthenticationConverter((responseToken) -> {
- Saml2Authentication authentication = delegate.convert(responseToken);
- Assertion assertion = responseToken.getResponse().getAssertions().get(0);
- AuthenticatedPrincipal principal = (AuthenticatedPrincipal) authentication.getPrincipal();
- Collection<GrantedAuthority> authorities = myAuthoritiesExtractor.convert(assertion);
- return new Saml2Authentication(principal, authentication.getSaml2Response(), authorities);
- });
- Converter<AssertionToken, Saml2ResponseValidationResult> validator = OpenSaml4AuthenticationProvider
- .createDefaultAssertionValidatorWithParameters((p) -> p.put(CLOCK_SKEW, myDuration));
- versionFour.setAssertionValidator(validator);
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val delegate = OpenSaml4AuthenticationProvider.createDefaultResponseAuthenticationConverter()
- val versionFour = OpenSaml4AuthenticationProvider()
- versionFour.setResponseAuthenticationConverter({
- responseToken -> {
- val authentication = delegate.convert(responseToken)
- val assertion = responseToken.getResponse().getAssertions().get(0)
- val principal = (AuthenticatedPrincipal) authentication.getPrincipal()
- val authorities = myAuthoritiesExtractor.convert(assertion)
- return Saml2Authentication(principal, authentication.getSaml2Response(), authorities)
- }
- })
- val validator = OpenSaml4AuthenticationProvider
- .createDefaultAssertionValidatorWithParameters({ p -> p.put(CLOCK_SKEW, myDuration) })
- versionFour.setAssertionValidator(validator)
- ----
- ====
- [[use-new-requestmatchers]]
- === Use the new `requestMatchers` methods
- In Spring Security 5.8, the {security-api-url}org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.html#antMatchers(java.lang.String...)[`antMatchers`], {security-api-url}org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.html#mvcMatchers(java.lang.String...)[`mvcMatchers`], and {security-api-url}org/springframework/security/config/annotation/web/AbstractRequestMatcherRegistry.html#regexMatchers(java.lang.String...)[`regexMatchers`] methods were deprecated in favor of new xref::servlet/authorization/authorize-http-requests.adoc#_request_matchers[`requestMatchers` methods].
- The new `requestMatchers` methods were added xref::servlet/authorization/authorize-http-requests.adoc[to `authorizeHttpRequests`], `authorizeRequests`, CSRF configuration, `WebSecurityCustomizer` and any other places that had the specialized `RequestMatcher` methods.
- The deprecated methods are removed in Spring Security 6.
- These new methods have more secure defaults since they choose the most appropriate `RequestMatcher` implementation for your application.
- In summary, the new methods choose the `MvcRequestMatcher` implementation if your application has Spring MVC in the classpath, falling back to the `AntPathRequestMatcher` implementation if Spring MVC is not present (aligning the behavior with the Kotlin equivalent methods).
- To start using the new methods, you can replace the deprecated methods with the new ones. For example, the following application configuration:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class SecurityConfig {
- @Bean
- public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authz) -> authz
- .antMatchers("/api/admin/**").hasRole("ADMIN")
- .antMatchers("/api/user/**").hasRole("USER")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- }
- ----
- ====
- can be changed to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- public class SecurityConfig {
- @Bean
- public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/api/admin/**").hasRole("ADMIN")
- .requestMatchers("/api/user/**").hasRole("USER")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- }
- ----
- ====
- If you have Spring MVC in the classpath and are using the `mvcMatchers` methods, you can replace it with the new methods and Spring Security will choose the `MvcRequestMatcher` implementation for you.
- The following configuration:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- @EnableWebMvc
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authz) -> authz
- .mvcMatchers("/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- }
- ----
- ====
- is equivalent to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- @EnableWebMvc
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- }
- ----
- ====
- If you are customizing the `servletPath` property of the `MvcRequestMatcher`, you can now use the `MvcRequestMatcher.Builder` to create `MvcRequestMatcher` instances that share the same servlet path:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- @EnableWebMvc
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authz) -> authz
- .mvcMatchers("/admin").servletPath("/path").hasRole("ADMIN")
- .mvcMatchers("/user").servletPath("/path").hasRole("USER")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- }
- ----
- ====
- The code above can be rewritten using the `MvcRequestMatcher.Builder` and the `requestMatchers` method:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- @EnableWebSecurity
- @EnableWebMvc
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http, HandlerMappingIntrospector introspector) throws Exception {
- MvcRequestMatcher.Builder mvcMatcherBuilder = new MvcRequestMatcher.Builder(introspector).servletPath("/path");
- http
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers(mvcMatcherBuilder.pattern("/admin")).hasRole("ADMIN")
- .requestMatchers(mvcMatcherBuilder.pattern("/user")).hasRole("USER")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- }
- ----
- ====
- If you are having problem with the new `requestMatchers` methods, you can always switch back to the `RequestMatcher` implementation that you were using.
- For example, if you still want to use `AntPathRequestMatcher` and `RegexRequestMatcher` implementations, you can use the `requestMatchers` method that accepts a `RequestMatcher` instance:
- ====
- .Java
- [source,java,role="primary"]
- ----
- import static org.springframework.security.web.util.matcher.AntPathRequestMatcher.antMatcher;
- import static org.springframework.security.web.util.matcher.RegexRequestMatcher.regexMatcher;
- @Configuration
- @EnableWebSecurity
- public class SecurityConfig {
- @Bean
- SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers(antMatcher("/user/**")).hasRole("USER")
- .requestMatchers(antMatcher(HttpMethod.POST, "/user/**")).hasRole("ADMIN")
- .requestMatchers(regexMatcher(".*\\?x=y")).hasRole("SPECIAL") // matches /any/path?x=y
- .anyRequest().authenticated()
- );
- return http.build();
- }
- }
- ----
- ====
- Note that the above sample uses static factory methods from {security-api-url}org/springframework/security/web/util/matcher/AntPathRequestMatcher.html[`AntPathRequestMatcher`] and {security-api-url}org/springframework/security/web/util/matcher/RegexRequestMatcher.html[`RegexRequestMatcher`] to improve readability.
- If you are using the `WebSecurityCustomizer` interface, you can replace the deprecated `antMatchers` methods:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public WebSecurityCustomizer webSecurityCustomizer() {
- return (web) -> web.ignoring().antMatchers("/ignore1", "/ignore2");
- }
- ----
- ====
- with their `requestMatchers` counterparts:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public WebSecurityCustomizer webSecurityCustomizer() {
- return (web) -> web.ignoring().requestMatchers("/ignore1", "/ignore2");
- }
- ----
- ====
- The same way, if you are customizing the CSRF configuration to ignore some paths, you can replace the deprecated methods with the `requestMatchers` methods:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .csrf((csrf) -> csrf
- .ignoringAntMatchers("/no-csrf")
- );
- return http.build();
- }
- ----
- ====
- can be changed to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .csrf((csrf) -> csrf
- .ignoringRequestMatchers("/no-csrf")
- );
- return http.build();
- }
- ----
- ====
- [[use-new-security-matchers]]
- === Use the new `securityMatchers` methods
- In Spring Security 5.8, the `antMatchers`, `mvcMatchers` and `requestMatchers` methods from `HttpSecurity` were deprecated in favor of new `securityMatchers` methods.
- Note that these methods are not the same from `authorizeHttpRequests` methods <<use-new-requestmatchers,which were deprecated>> in favor of the `requestMatchers` methods.
- However, the `securityMatchers` methods are similar to the `requestMatchers` methods in the sense that they will choose the most appropriate `RequestMatcher` implementation for your application.
- In summary, the new methods choose the `MvcRequestMatcher` implementation if your application has Spring MVC in the classpath, falling back to the `AntPathRequestMatcher` implementation if Spring MVC is not present (aligning the behavior with the Kotlin equivalent methods).
- Another reason for adding the `securityMatchers` methods is to avoid confusion with the `requestMatchers` methods from `authorizeHttpRequests`.
- The following configuration:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .antMatcher("/api/**", "/app/**")
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/api/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- ----
- ====
- can be rewritten using the `securityMatchers` methods:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .securityMatcher("/api/**", "/app/**")
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/api/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- ----
- ====
- If you are using a custom `RequestMatcher` in your `HttpSecurity` configuration:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .requestMatcher(new MyCustomRequestMatcher())
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/api/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- public class MyCustomRequestMatcher implements RequestMatcher {
- // ...
- }
- ----
- ====
- you can do the same using `securityMatcher`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .securityMatcher(new MyCustomRequestMatcher())
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/api/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- public class MyCustomRequestMatcher implements RequestMatcher {
- // ...
- }
- ----
- ====
- If you are combining multiple `RequestMatcher` implementations in your `HttpSecurity` configuration:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .requestMatchers((matchers) -> matchers
- .antMatchers("/api/**", "/app/**")
- .mvcMatchers("/admin/**")
- .requestMatchers(new MyCustomRequestMatcher())
- )
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- ----
- ====
- you can change it by using `securityMatchers`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .securityMatchers((matchers) -> matchers
- .requestMatchers("/api/**", "/app/**", "/admin/**")
- .requestMatchers(new MyCustomRequestMatcher())
- )
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers("/admin/**").hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- ----
- ====
- If you are having problems with the `securityMatchers` methods choosing the `RequestMatcher` implementation for you, you can always choose the `RequestMatcher` implementation yourself:
- ====
- .Java
- [source,java,role="primary"]
- ----
- import static org.springframework.security.web.util.matcher.AntPathRequestMatcher.antMatcher;
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .securityMatcher(antMatcher("/api/**"), antMatcher("/app/**"))
- .authorizeHttpRequests((authz) -> authz
- .requestMatchers(antMatcher("/api/admin/**")).hasRole("ADMIN")
- .anyRequest().authenticated()
- );
- return http.build();
- }
- ----
- ====
- === Stop using `Encryptors.queryableText`
- `Encryptors.queryableText(CharSequence,CharSequence)` is unsafe since https://tanzu.vmware.com/security/cve-2020-5408[the same input data will produce the same output].
- It was deprecated and will be removed in 6.0; Spring Security no longer supports encrypting data in this way.
- To upgrade, you will either need to re-encrypt with a supported mechanism or store it decrypted.
- Consider the following pseudocode for reading each encrypted entry from a table, decrypting it, and then re-encrypting it using a supported mechanism:
- ====
- .Java
- [source,java,role="primary"]
- ----
- TextEncryptor deprecated = Encryptors.queryableText(password, salt);
- BytesEncryptor aes = new AesBytesEncryptor(password, salt, KeyGenerators.secureRandom(12), CipherAlgorithm.GCM);
- TextEncryptor supported = new HexEncodingTextEncryptor(aes);
- for (MyEntry entry : entries) {
- String value = deprecated.decrypt(entry.getEncryptedValue()); <1>
- entry.setEncryptedValue(supported.encrypt(value)); <2>
- entryService.save(entry)
- }
- ----
- ====
- <1> - The above uses the deprecated `queryableText` to convert the value to plaintext.
- <2> - Then, the value is re-encrypted with a supported Spring Security mechanism.
- Please see the reference manual for more information on what xref:features/integrations/cryptography.adoc[encryption mechanisms Spring Security supports].
- === Default authorities for oauth2Login()
- In Spring Security 5, the default `GrantedAuthority` given to a user that authenticates with an OAuth2 or OpenID Connect 1.0 provider (via `oauth2Login()`) is `ROLE_USER`.
- [NOTE]
- ====
- See xref:servlet/oauth2/login/advanced.adoc#oauth2login-advanced-map-authorities[Mapping User Authorities] for more information.
- ====
- In Spring Security 6, the default authority given to a user authenticating with an OAuth2 provider is `OAUTH2_USER`.
- The default authority given to a user authenticating with an OpenID Connect 1.0 provider is `OIDC_USER`.
- These defaults allow clearer distinction of users that have authenticated with an OAuth2 or OpenID Connect 1.0 provider.
- If you are using authorization rules or expressions such as `hasRole("USER")` or `hasAuthority("ROLE_USER")` to authorize users with this specific authority, the new defaults in Spring Security 6 will impact your application.
- To opt into the new Spring Security 6 defaults, the following configuration can be used.
- .Configure oauth2Login() with 6.0 defaults
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .oauth2Login((oauth2Login) -> oauth2Login
- .userInfoEndpoint((userInfo) -> userInfo
- .userAuthoritiesMapper(grantedAuthoritiesMapper())
- )
- );
- return http.build();
- }
- private GrantedAuthoritiesMapper grantedAuthoritiesMapper() {
- return (authorities) -> {
- Set<GrantedAuthority> mappedAuthorities = new HashSet<>();
- authorities.forEach((authority) -> {
- GrantedAuthority mappedAuthority;
- if (authority instanceof OidcUserAuthority) {
- OidcUserAuthority userAuthority = (OidcUserAuthority) authority;
- mappedAuthority = new OidcUserAuthority(
- "OIDC_USER", userAuthority.getIdToken(), userAuthority.getUserInfo());
- } else if (authority instanceof OAuth2UserAuthority) {
- OAuth2UserAuthority userAuthority = (OAuth2UserAuthority) authority;
- mappedAuthority = new OAuth2UserAuthority(
- "OAUTH2_USER", userAuthority.getAttributes());
- } else {
- mappedAuthority = authority;
- }
- mappedAuthorities.add(mappedAuthority);
- });
- return mappedAuthorities;
- };
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- oauth2Login {
- userInfoEndpoint {
- userAuthoritiesMapper = grantedAuthoritiesMapper()
- }
- }
- }
- return http.build()
- }
- private fun grantedAuthoritiesMapper(): GrantedAuthoritiesMapper {
- return GrantedAuthoritiesMapper { authorities ->
- authorities.map { authority ->
- when (authority) {
- is OidcUserAuthority ->
- OidcUserAuthority("OIDC_USER", authority.idToken, authority.userInfo)
- is OAuth2UserAuthority ->
- OAuth2UserAuthority("OAUTH2_USER", authority.attributes)
- else -> authority
- }
- }
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <oauth2-login user-authorities-mapper-ref="userAuthoritiesMapper" ... />
- </http>
- ----
- ====
- [[servlet-oauth2-login-authorities-opt-out]]
- ==== Opt-out Steps
- If configuring the new authorities gives you trouble, you can opt out and explicitly use the 5.8 authority of `ROLE_USER` with the following configuration.
- .Configure oauth2Login() with 5.8 defaults
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception {
- http
- // ...
- .oauth2Login((oauth2Login) -> oauth2Login
- .userInfoEndpoint((userInfo) -> userInfo
- .userAuthoritiesMapper(grantedAuthoritiesMapper())
- )
- );
- return http.build();
- }
- private GrantedAuthoritiesMapper grantedAuthoritiesMapper() {
- return (authorities) -> {
- Set<GrantedAuthority> mappedAuthorities = new HashSet<>();
- authorities.forEach((authority) -> {
- GrantedAuthority mappedAuthority;
- if (authority instanceof OidcUserAuthority) {
- OidcUserAuthority userAuthority = (OidcUserAuthority) authority;
- mappedAuthority = new OidcUserAuthority(
- "ROLE_USER", userAuthority.getIdToken(), userAuthority.getUserInfo());
- } else if (authority instanceof OAuth2UserAuthority) {
- OAuth2UserAuthority userAuthority = (OAuth2UserAuthority) authority;
- mappedAuthority = new OAuth2UserAuthority(
- "ROLE_USER", userAuthority.getAttributes());
- } else {
- mappedAuthority = authority;
- }
- mappedAuthorities.add(mappedAuthority);
- });
- return mappedAuthorities;
- };
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun securityFilterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- // ...
- oauth2Login {
- userInfoEndpoint {
- userAuthoritiesMapper = grantedAuthoritiesMapper()
- }
- }
- }
- return http.build()
- }
- private fun grantedAuthoritiesMapper(): GrantedAuthoritiesMapper {
- return GrantedAuthoritiesMapper { authorities ->
- authorities.map { authority ->
- when (authority) {
- is OidcUserAuthority ->
- OidcUserAuthority("ROLE_USER", authority.idToken, authority.userInfo)
- is OAuth2UserAuthority ->
- OAuth2UserAuthority("ROLE_USER", authority.attributes)
- else -> authority
- }
- }
- }
- }
- ----
- .XML
- [source,xml,role="secondary"]
- ----
- <http>
- <oauth2-login user-authorities-mapper-ref="userAuthoritiesMapper" ... />
- </http>
- ----
- ====
- === Stop Using `WebSecurityConfigurerAdapter`
- ==== Publish a `SecurityFilterChain` Bean
- Spring Security 5.4 introduced the capability to publish a `SecurityFilterChain` bean instead of extending `WebSecurityConfigurerAdapter`.
- In 6.0, `WebSecurityConfigurerAdapter` is removed.
- To prepare for this change, you can replace constructs like:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
- @Override
- protected void configure(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authorize) -> authorize
- .anyRequest().authenticated()
- )
- .httpBasic(withDefaults());
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration: WebSecurityConfigurerAdapter() {
- @Override
- override fun configure(val http: HttpSecurity) {
- http {
- authorizeHttpRequests {
- authorize(anyRequest, authenticated)
- }
- httpBasic {}
- }
- }
- }
- ----
- ====
- with:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration {
- @Bean
- public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
- http
- .authorizeHttpRequests((authorize) -> authorize
- .anyRequest().authenticated()
- )
- .httpBasic(withDefaults());
- return http.build();
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration {
- @Bean
- fun filterChain(http: HttpSecurity): SecurityFilterChain {
- http {
- authorizeHttpRequests {
- authorize(anyRequest, authenticated)
- }
- httpBasic {}
- }
- return http.build()
- }
- }
- ----
- ====
- ==== Publish an `AuthenticationManager` Bean
- As part of `WebSecurityConfigurerAdapeter` removal, `configure(AuthenticationManagerBuilder)` is also removed.
- Preparing for its removal will differ based on your reason for using it.
- ===== LDAP Authentication
- If you are using `auth.ldapAuthentication()` for xref:servlet/authentication/passwords/ldap.adoc[LDAP authentication support], you can replace:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
- @Override
- protected void configure(AuthenticationManagerBuilder auth) throws Exception {
- auth
- .ldapAuthentication()
- .userDetailsContextMapper(new PersonContextMapper())
- .userDnPatterns("uid={0},ou=people")
- .contextSource()
- .port(0);
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration: WebSecurityConfigurerAdapter() {
- override fun configure(auth: AuthenticationManagerBuilder) {
- auth
- .ldapAuthentication()
- .userDetailsContextMapper(PersonContextMapper())
- .userDnPatterns("uid={0},ou=people")
- .contextSource()
- .port(0)
- }
- }
- ----
- ====
- with:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration {
- @Bean
- public EmbeddedLdapServerContextSourceFactoryBean contextSourceFactoryBean() {
- EmbeddedLdapServerContextSourceFactoryBean contextSourceFactoryBean =
- EmbeddedLdapServerContextSourceFactoryBean.fromEmbeddedLdapServer();
- contextSourceFactoryBean.setPort(0);
- return contextSourceFactoryBean;
- }
- @Bean
- AuthenticationManager ldapAuthenticationManager(BaseLdapPathContextSource contextSource) {
- LdapBindAuthenticationManagerFactory factory =
- new LdapBindAuthenticationManagerFactory(contextSource);
- factory.setUserDnPatterns("uid={0},ou=people");
- factory.setUserDetailsContextMapper(new PersonContextMapper());
- return factory.createAuthenticationManager();
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration {
- @Bean
- fun contextSourceFactoryBean(): EmbeddedLdapServerContextSourceFactoryBean {
- val contextSourceFactoryBean: EmbeddedLdapServerContextSourceFactoryBean =
- EmbeddedLdapServerContextSourceFactoryBean.fromEmbeddedLdapServer()
- contextSourceFactoryBean.setPort(0)
- return contextSourceFactoryBean
- }
- @Bean
- fun ldapAuthenticationManager(val contextSource: BaseLdapPathContextSource): AuthenticationManager {
- val factory = LdapBindAuthenticationManagerFactory(contextSource)
- factory.setUserDnPatterns("uid={0},ou=people")
- factory.setUserDetailsContextMapper(PersonContextMapper())
- return factory.createAuthenticationManager()
- }
- }
- ----
- ====
- ===== JDBC Authentication
- If you are using `auth.jdbcAuthentication()` for xref:servlet/authentication/passwords/jdbc.adoc[JDBC Authentication support], you can replace:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
- @Bean
- public DataSource dataSource() {
- return new EmbeddedDatabaseBuilder()
- .setType(EmbeddedDatabaseType.H2)
- .build();
- }
- @Override
- protected void configure(AuthenticationManagerBuilder auth) throws Exception {
- UserDetails user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build();
- auth.jdbcAuthentication()
- .withDefaultSchema()
- .dataSource(this.dataSource)
- .withUser(user);
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration: WebSecurityConfigurerAdapter() {
- @Bean
- fun dataSource(): DataSource {
- return EmbeddedDatabaseBuilder()
- .setType(EmbeddedDatabaseType.H2)
- .build()
- }
- override fun configure(val auth: AuthenticationManagerBuilder) {
- UserDetails user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build()
- auth.jdbcAuthentication()
- .withDefaultSchema()
- .dataSource(this.dataSource)
- .withUser(user)
- }
- }
- ----
- ====
- with:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration {
- @Bean
- public DataSource dataSource() {
- return new EmbeddedDatabaseBuilder()
- .setType(EmbeddedDatabaseType.H2)
- .addScript(JdbcDaoImpl.DEFAULT_USER_SCHEMA_DDL_LOCATION)
- .build();
- }
- @Bean
- public UserDetailsManager users(DataSource dataSource) {
- UserDetails user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build();
- JdbcUserDetailsManager users = new JdbcUserDetailsManager(dataSource);
- users.createUser(user);
- return users;
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration {
- @Bean
- fun dataSource(): DataSource {
- return EmbeddedDatabaseBuilder()
- .setType(EmbeddedDatabaseType.H2)
- .addScript(JdbcDaoImpl.DEFAULT_USER_SCHEMA_DDL_LOCATION)
- .build()
- }
- @Bean
- fun users(val dataSource: DataSource): UserDetailsManager {
- val user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build()
- val users = JdbcUserDetailsManager(dataSource)
- users.createUser(user)
- return users
- }
- }
- ----
- ====
- ===== In-Memory Authentication
- If you are using `auth.inMemoryAuthentication()` for xref:servlet/authentication/passwords/in-memory.adoc[In-Memory Authentication support], you can replace:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
- @Override
- protected void configure(AuthenticationManagerBuilder auth) throws Exception {
- UserDetails user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build();
- auth.inMemoryAuthentication()
- .withUser(user);
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration: WebSecurityConfigurerAdapter() {
- override fun configure(val auth: AuthenticationManagerBuilder) {
- val user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build()
- auth.inMemoryAuthentication()
- .withUser(user)
- }
- }
- ----
- ====
- with:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration {
- @Bean
- public InMemoryUserDetailsManager userDetailsService() {
- UserDetails user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build();
- return new InMemoryUserDetailsManager(user);
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration {
- @Bean
- fun userDetailsService(): InMemoryUserDetailsManager {
- UserDetails user = User.withDefaultPasswordEncoder()
- .username("user")
- .password("password")
- .roles("USER")
- .build()
- return InMemoryUserDetailsManager(user)
- }
- }
- ----
- ====
- ===== Other Scenarios
- If you are using `AuthenticationManagerBuilder` for something more sophisticated, you can xref:servlet/authentication/architecture.adoc#servlet-authentication-authenticationmanager[publish your own `AuthenticationManager` `@Bean`] or wire an `AuthenticationManager` instance into the `HttpSecurity` DSL with {security-api-url}org/springframework/security/config/annotation/web/builders/HttpSecurity.html#authenticationManager(org.springframework.security.authentication.AuthenticationManager)[`HttpSecurity#authenticationManager`].
- ==== Publish a `WebSecurityCustomizer` Bean
- Spring Security 5.4 https://github.com/spring-projects/spring-security/issues/8978[introduced `WebSecurityCustomizer`] to replace `configure(WebSecurity web)` in `WebSecurityConfigurerAdapter`.
- To prepare for its removal, you can replace code like the following:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
- @Override
- public void configure(WebSecurity web) {
- web.ignoring().antMatchers("/ignore1", "/ignore2");
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration: WebSecurityConfigurerAdapter() {
- override fun configure(val web: WebSecurity) {
- web.ignoring().antMatchers("/ignore1", "/ignore2")
- }
- }
- ----
- ====
- with:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Configuration
- public class SecurityConfiguration {
- @Bean
- public WebSecurityCustomizer webSecurityCustomizer() {
- return (web) -> web.ignoring().antMatchers("/ignore1", "/ignore2");
- }
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Configuration
- open class SecurityConfiguration {
- @Bean
- fun webSecurityCustomizer(): WebSecurityCustomizer {
- return (web) -> web.ignoring().antMatchers("/ignore1", "/ignore2")
- }
- }
- ----
- ====
- === Update Password Encoding
- In 6.0, password encoding minimums are updated for PBKDF2, SCrypt, and Argon2.
- [NOTE]
- ====
- If you are using the default password encoder, then there are no preparation steps to follow and this section can be skipped.
- ====
- ==== Update `Pbkdf2PasswordEncoder`
- If you are xref:features/authentication/password-storage.adoc#authentication-password-storage-pbkdf2[using `Pbkdf2PasswordEncoder`], the constructors are replaced with static factories that refer to the Spring Security version that the given settings apply to.
- ===== Replace Deprecated Constructor Usage
- If you use the default constructor, you should begin by changing:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- return new Pbkdf2PasswordEncoder();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- return Pbkdf2PasswordEncoder()
- }
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- return Pbkdf2PasswordEncoder.defaultsForSpringSecurity_v5_5();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- return Pbkdf2PasswordEncoder.defaultsForSpringSecurity_v5_5()
- }
- ----
- ====
- Or, if you have custom settings, change to the constructor that specifies all settings, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- PasswordEncoder current = new Pbkdf2PasswordEncoder("mysecret".getBytes(UTF_8), 320000);
- return current;
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- val current: PasswordEncoder = Pbkdf2PasswordEncoder("mysecret".getBytes(UTF_8), 320000)
- return current
- }
- ----
- ====
- Change them to use the fully-specified constructor, like the following:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- PasswordEncoder current = new Pbkdf2PasswordEncoder("mysecret".getBytes(UTF_8), 16, 185000, 256);
- return current;
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- val current: PasswordEncoder = Pbkdf2PasswordEncoder("mysecret".getBytes(UTF_8), 16, 185000, 256)
- return current
- }
- ----
- ====
- ===== Use `DelegatedPasswordEncoder`
- Once you are not using the deprecated constructor, the next step is to prepare your code to upgrade to the latest standards by using `DelegatedPasswordEncoder`.
- The following code configures the delegating encoder to detect passwords that are using `current` and replace them with the latest:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- String prefix = "pbkdf2@5.8";
- PasswordEncoder current = // ... see previous step
- PasswordEncoder upgraded = Pbkdf2PasswordEncoder.defaultsForSpringSecurity_v5_8();
- DelegatedPasswordEncoder delegating = new DelegatedPasswordEncoder(prefix, Map.of(prefix, upgraded));
- delegating.setDefaultPasswordEncoderFormatches(current);
- return delegating;
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- String prefix = "pbkdf2@5.8"
- PasswordEncoder current = // ... see previous step
- PasswordEncoder upgraded = Pbkdf2PasswordEncoder.defaultsForSpringSecurity_v5_8()
- DelegatedPasswordEncoder delegating = new DelegatedPasswordEncoder(prefix, Map.of(prefix, upgraded))
- delegating.setDefaultPasswordEncoderFormatches(current)
- return delegating
- }
- ----
- ====
- ==== Update `SCryptPasswordEncoder`
- If you are xref:features/authentication/password-storage.adoc#authentication-password-storage-scrypt[using `SCryptPasswordEncoder`], the constructors are replaced with static factories that refer to the Spring Security version that the given settings apply to.
- ===== Replace Deprecated Constructor Usage
- If you use the default constructor, you should begin by changing:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- return new SCryptPasswordEncoder();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- return SCryptPasswordEncoder()
- }
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- return SCryptPasswordEncoder.defaultsForSpringSecurity_v4_1();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- return SCryptPasswordEncoder.defaultsForSpringSecurity_v4_1()
- }
- ----
- ====
- ===== Use `DelegatedPasswordEncoder`
- Once you are not using the deprecated constructor, the next step is to prepare your code to upgrade to the latest standards by using `DelegatedPasswordEncoder`.
- The following code configures the delegating encoder to detect passwords that are using `current` and replace them with the latest:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- String prefix = "scrypt@5.8";
- PasswordEncoder current = // ... see previous step
- PasswordEncoder upgraded = SCryptPasswordEncoder.defaultsForSpringSecurity_v5_8();
- DelegatedPasswordEncoder delegating = new DelegatedPasswordEncoder(prefix, Map.of(prefix, upgraded));
- delegating.setDefaultPasswordEncoderFormatches(current);
- return delegating;
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- String prefix = "scrypt@5.8"
- PasswordEncoder current = // ... see previous step
- PasswordEncoder upgraded = SCryptPasswordEncoder.defaultsForSpringSecurity_v5_8()
- DelegatedPasswordEncoder delegating = new DelegatedPasswordEncoder(prefix, Map.of(prefix, upgraded))
- delegating.setDefaultPasswordEncoderFormatches(current)
- return delegating
- }
- ----
- ====
- ==== Update `Argon2PasswordEncoder`
- If you are xref:features/authentication/password-storage.adoc#authentication-password-storage-argon2[using `Argon2PasswordEncoder`], the constructors are replaced with static factories that refer to the Spring Security version that the given settings apply to.
- ===== Replace Deprecated Constructor Usage
- If you use the default constructor, you should begin by changing:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- return new Argon2PasswordEncoder();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- return Argon2PasswordEncoder()
- }
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- return Argon2PasswordEncoder.defaultsForSpringSecurity_v5_2();
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- return Argon2PasswordEncoder.defaultsForSpringSecurity_v5_2()
- }
- ----
- ====
- ===== Use `DelegatedPasswordEncoder`
- Once you are not using the deprecated constructor, the next step is to prepare your code to upgrade to the latest standards by using `DelegatedPasswordEncoder`.
- The following code configures the delegating encoder to detect passwords that are using `current` and replace them with the latest:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @Bean
- PasswordEncoder passwordEncoder() {
- String prefix = "argon@5.8";
- PasswordEncoder current = // ... see previous step
- PasswordEncoder upgraded = Argon2PasswordEncoder.defaultsForSpringSecurity_v5_8();
- DelegatedPasswordEncoder delegating = new DelegatedPasswordEncoder(prefix, Map.of(prefix, upgraded));
- delegating.setDefaultPasswordEncoderFormatches(current);
- return delegating;
- }
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @Bean
- fun passwordEncoder(): PasswordEncoder {
- String prefix = "argon@5.8"
- PasswordEncoder current = // ... see previous step
- PasswordEncoder upgraded = Argon2PasswordEncoder.defaultsForSpringSecurity_v5_8()
- DelegatedPasswordEncoder delegating = new DelegatedPasswordEncoder(prefix, Map.of(prefix, upgraded))
- delegating.setDefaultPasswordEncoderFormatches(current)
- return delegating
- }
- ----
- ====
- == Reactive
- === Use `AuthorizationManager` for Method Security
- xref:reactive/authorization/method.adoc[Method Security] has been xref:reactive/authorization/method.adoc#jc-enable-reactive-method-security-authorization-manager[improved] through {security-api-url}org/springframework/security/authorization/AuthorizationManager.html[the `AuthorizationManager` API] and direct use of Spring AOP.
- Should you run into trouble with making these changes, you can follow the
- <<reactive-authorizationmanager-methods-opt-out,opt out steps>> at the end of this section.
- In Spring Security 5.8, `useAuthorizationManager` was added to {security-api-url}org/springframework/security/config/annotation/method/configuration/EnableReactiveMethodSecurity.html[`@EnableReactiveMethodSecurity`] to allow applications to opt in to ``AuthorizationManager``'s features.
- [[reactive-change-to-useauthorizationmanager]]
- ==== Change `useAuthorizationManager` to `true`
- To opt in, change `useAuthorizationManager` to `true` like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableReactiveMethodSecurity
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableReactiveMethodSecurity
- ----
- ====
- changes to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableReactiveMethodSecurity(useAuthorizationManager = true)
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableReactiveMethodSecurity(useAuthorizationManager = true)
- ----
- ====
- [[reactive-check-for-annotationconfigurationexceptions]]
- ==== Check for ``AnnotationConfigurationException``s
- `useAuthorizationManager` activates stricter enforcement of Spring Security's non-repeatable or otherwise incompatible annotations.
- If after turning on `useAuthorizationManager` you see ``AnnotationConfigurationException``s in your logs, follow the instructions in the exception message to clean up your application's method security annotation usage.
- [[reactive-authorizationmanager-methods-opt-out]]
- ==== Opt-out Steps
- If you ran into trouble with `AuthorizationManager` for reactive method security, you can opt out by changing:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableReactiveMethodSecurity
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableReactiveMethodSecurity
- ----
- ====
- to:
- ====
- .Java
- [source,java,role="primary"]
- ----
- @EnableReactiveMethodSecurity(useAuthorizationManager = false)
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- @EnableReactiveMethodSecurity(useAuthorizationManager = false)
- ----
- ====
- === Propagate ``AuthenticationServiceException``s
- {security-api-url}org/springframework/security/web/server/Webauthentication/AuthenticationWebFilter.html[`AuthenticationFilter`] propagates {security-api-url}org/springframework/security/authentication/AuthenticationServiceException.html[``AuthenticationServiceException``]s to the {security-api-url}org/springframework/security/web/server/ServerAuthenticationEntryPoint.html[`ServerAuthenticationEntryPoint`].
- Because ``AuthenticationServiceException``s represent a server-side error instead of a client-side error, in 6.0, this changes to propagate them to the container.
- ==== Configure `ServerAuthenticationFailureHandler` to rethrow ``AuthenticationServiceException``s
- To prepare for the 6.0 default, `httpBasic` and `oauth2ResourceServer` should be configured to rethrow ``AuthenticationServiceException``s.
- For each, construct the appropriate authentication entry point for `httpBasic` and for `oauth2ResourceServer`:
- ====
- .Java
- [source,java,role="primary"]
- ----
- ServerAuthenticationEntryPoint bearerEntryPoint = new BearerTokenServerAuthenticationEntryPoint();
- ServerAuthenticationEntryPoint basicEntryPoint = new HttpStatusServerEntryPoint(HttpStatus.UNAUTHORIZED);
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val bearerEntryPoint: ServerAuthenticationEntryPoint = BearerTokenServerAuthenticationEntryPoint()
- val basicEntryPoint: ServerAuthenticationEntryPoint = HttpStatusServerEntryPoint(HttpStatus.UNAUTHORIZED)
- ----
- ====
- [NOTE]
- ====
- If you use a custom `AuthenticationEntryPoint` for either or both mechanisms, use that one instead for the remaining steps.
- ====
- Then, construct and configure a `ServerAuthenticationEntryPointFailureHandler` for each one:
- ====
- .Java
- [source,java,role="primary"]
- ----
- AuthenticationFailureHandler bearerFailureHandler = new ServerAuthenticationEntryPointFailureHandler(bearerEntryPoint);
- bearerFailureHandler.setRethrowAuthenticationServiceException(true);
- AuthenticationFailureHandler basicFailureHandler = new ServerAuthenticationEntryPointFailureHandler(basicEntryPoint);
- basicFailureHandler.setRethrowAuthenticationServiceException(true)
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- val bearerFailureHandler: AuthenticationFailureHandler = ServerAuthenticationEntryPointFailureHandler(bearerEntryPoint)
- bearerFailureHandler.setRethrowAuthenticationServiceException(true)
- val basicFailureHandler: AuthenticationFailureHandler = ServerAuthenticationEntryPointFailureHandler(basicEntryPoint)
- basicFailureHandler.setRethrowAuthenticationServiceException(true)
- ----
- ====
- Finally, wire each authentication failure handler into the DSL, like so:
- ====
- .Java
- [source,java,role="primary"]
- ----
- http
- .httpBasic((basic) -> basic.authenticationFailureHandler(basicFailureHandler))
- .oauth2ResourceServer((oauth2) -> oauth2.authenticationFailureHandler(bearerFailureHandler))
- ----
- .Kotlin
- [source,kotlin,role="secondary"]
- ----
- http {
- httpBasic {
- authenticationFailureHandler = basicFailureHandler
- }
- oauth2ResourceServer {
- authenticationFailureHandler = bearerFailureHandler
- }
- }
- ----
- ====
- [[reactive-authenticationfailurehandler-opt-out]]
- ==== Opt-out Steps
- To opt-out of the 6.0 defaults and instead continue to pass `AuthenticationServiceException` on to ``ServerAuthenticationEntryPoint``s, you can follow the same steps as above, except set `rethrowAuthenticationServiceException` to false.
|