חזרה לפיד
articlesמקור: Security Docs — java

Spring Security — הגנת CSRF

אמ;לק

תצורת CSRF רשמית של Spring Security והסיכונים בביטול גורף.

סיכום בעברית: מערכת VibeSec · מדיניות המקורות

נוסף ל-VibeSec:

$cat article.txt

>תצורת CSRF רשמית של Spring Security והסיכונים בביטול גורף.

התוכן המלא בעברית

תרגום אוטומטי מהמקור; מונחים טכניים נשארו באנגלית. לנוסח המחייב — הכתבה המקורית.

ביישום שבו משתמשי קצה יכולים להתחבר, חשוב לשקול כיצד להגן מפני Cross Site Request Forgery (CSRF).

‏Spring Security מגן מפני התקפות CSRF כברירת מחדל עבור שיטות HTTP לא בטוחות (unsafe), כגון בקשות POST, כך שאין צורך בקוד נוסף. ניתן לציין את תצורת ברירת המחדל במפורש באופן הבא:

⁦@Configuration @EnableWebSecurity public class SecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { http // ... .csrf(Customizer.withDefaults()); return http.build(); } }⁩

⁦import org.springframework.security.config.annotation.web.invoke @Configuration @EnableWebSecurity class SecurityConfig { @Bean open fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http { // ... csrf { } } return http.build() } }⁩

⁦<http> <!-- ... --> <csrf/> </http>⁩

למידע נוסף על הגנת CSRF עבור האפליקציה שלך, עיין במקרי השימוש הבאים:

• אני רוצה להבין את מרכיבי הגנת ה-CSRF

• אני צריך לבצע מיגרציה (הגירה) של אפליקציה מ-Spring Security 5 ל-6

• אני רוצה לאחסן את ה-CsrfToken ב-cookie במקום ב-session

• אני רוצה לאחסן את ⁦CsrfToken⁩ במיקום מותאם אישית

• אני צריך הדרכה המשלבת ⁦Thymeleaf⁩, ⁦JSPs⁩ או טכנולוגיית תצוגה אחרת עם הקצה האחורי

• אני צריך הדרכה המשלבת ⁦Angular⁩ או מסגרת ⁦JavaScript⁩ אחרת עם הקצה האחורי

• אני צריך הדרכה לשילוב אפליקציה סלולרית או לקוח אחר עם הקצה האחורי

• אני צריך הדרכה לגבי השבתת הגנת ה-CSRF

הבנת מרכיבי הגנת ה-CSRF

הגנת CSRF מסופקת על ידי מספר רכיבים המשולבים בתוך CsrfFilter:

ההגנה ⁦CSRF⁩ מחולקת לשני חלקים:

• הנגשת ה-CsrfToken לאפליקציה על ידי האצלת הפעולה ל-CsrfTokenRequestHandler.

• קביעה האם הבקשה דורשת הגנת CSRF, טעינה ואימות של האסימון, וטיפול ב-AccessDeniedException.

• ראשית, נטען ה-DeferredCsrfToken, שמחזיק הפניה ל-CsrfTokenRepository כך שניתן יהיה לטעון את ה-CsrfToken שנשמר מאוחר יותר.

• שנית, מועבר Supplier<CsrfToken> (שנוצר מ-DeferredCsrfToken) ל-CsrfTokenRequestHandler, שאחראי על אכלוס מאפיין בקשה (request attribute) כדי להנגיש את ה-CsrfToken לשאר חלקי האפליקציה.

• לאחר מכן, מתחיל עיבוד הגנת ה-CSRF הראשי והוא בודק אם הבקשה הנוכחית דורשת הגנת CSRF. אם לא נדרשת הגנה, שרשרת הסינון (filter chain) ממשיכה והעיבוד מסתיים.

• אם נדרשת הגנת CSRF, ה-CsrfToken שנשמר נטען לבסוף מתוך ה-DeferredCsrfToken.

• בהמשך, אסימון ה-CSRF שסופק בפועל על ידי הלקוח (אם קיים) מפוענח באמצעות CsrfTokenRequestHandler.

• אסימון ה-CSRF בפועל מושווה מול ה-CsrfToken שנשמר. אם הוא תקף, שרשרת הסינון ממשיכה והעיבוד מסתיים.

• אם אסימון ה-CSRF אינו חוקי (או חסר), נזרק AccessDeniedException המועבר אל ה-AccessDeniedHandler והעיבוד מסתיים.

מעבר ל-Spring Security 6

בעת מעבר מ-Spring Security 5 ל-6, ישנם כמה שינויים שעשויים להשפיע על האפליקציה שלך. להלן סקירה של היבטי הגנת ה-CSRF שהשתנו ב-Spring Security 6:

• טעינת ה-CsrfToken נדחית כעת כברירת מחדל כדי לשפר את הביצועים, מאחר שאין עוד צורך לטעון את ה-session בכל בקשה.

• ה-CsrfToken כולל כעת אקראיות בכל בקשה כברירת מחדל כדי להגן על אסימון ה-CSRF מפני התקפת BREACH.

השינויים ב-⁦Spring Security⁩ 6 דורשים תצורה נוספת עבור יישומי עמוד בודד, וככאלה, ייתכן שתמצא את הסעיף ⁦Single-Page Applications⁩ שימושי במיוחד.

עיין בסעיף Exploit Protection בפרק Migration למידע נוסף על העברת אפליקציית Spring Security 5.

התמדה (Persistence) של ה-CsrfToken

ה-CsrfToken נשמר באמצעות CsrfTokenRepository.

כברירת מחדל, נעשה שימוש ב-HttpSessionCsrfTokenRepository לאחסון אסימונים ב-session. Spring Security מספק גם את CookieCsrfTokenRepository לאחסון אסימונים ב-cookie. ניתן גם לציין מימוש מותאם אישית משלך כדי לאחסן אסימונים בכל מקום שתרצה.

שימוש ב-⁦HttpSessionCsrfTokenRepository⁩

כברירת מחדל, ⁦Spring Security⁩ מאחסן את האסימון הצפוי ⁦CSRF⁩ ב-⁦HttpSession⁩ באמצעות ⁦HttpSessionCsrfTokenRepository⁩ , כך שאין צורך בקוד נוסף.

ה-HttpSessionCsrfTokenRepository קורא את האסימון מתוך ה-session (בין אם בזיכרון, במטמון או במסד נתונים). אם עליך לגשת ישירות למאפיין ה-session, הגדר תחילה את שם המאפיין באמצעות HttpSessionCsrfTokenRepository#setSessionAttributeName.

אתה יכול לציין את תצורת ברירת המחדל במפורש באמצעות התצורה הבאה:

⁦@Configuration @EnableWebSecurity public class SecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { http // ... .csrf((csrf) -> csrf .csrfTokenRepository(new HttpSessionCsrfTokenRepository()) ); return http.build(); } }⁩

⁦import org.springframework.security.config.annotation.web.invoke @Configuration @EnableWebSecurity class SecurityConfig { @Bean open fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http { // ... csrf { csrfTokenRepository = HttpSessionCsrfTokenRepository() } } return http.build() } }⁩

⁦<http> <!-- ... --> <csrf token-repository-ref="tokenRepository"/> </http> <b:bean id="tokenRepository" class="org.springframework.security.web.csrf.HttpSessionCsrfTokenRepository"/>⁩

שימוש ב-⁦CookieCsrfTokenRepository⁩

ניתן לשמור את ה-CsrfToken בתוך cookie כדי לתמוך באפליקציות מבוססות JavaScript באמצעות CookieCsrfTokenRepository.

ה-CookieCsrfTokenRepository כותב כברירת מחדל ל-cookie בשם XSRF-TOKEN וקורא אותו מכותרת בקשת HTTP בשם X-XSRF-TOKEN או מפרמטר הבקשה _csrf. ברירות מחדל אלו מגיעות מ-Angular ומהקודמתה, AngularJS.

עיין ב-HttpClient XSRF/CSRF security וב-withXsrfConfiguration למידע עדכני יותר בנושא זה.

אתה יכול להגדיר את ⁦CookieCsrfTokenRepository⁩ באמצעות התצורה הבאה:

⁦@Configuration @EnableWebSecurity public class SecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { http // ... .csrf((csrf) -> csrf .csrfTokenRepository(CookieCsrfTokenRepository.withHttpOnlyFalse()) ); return http.build(); } }⁩

⁦import org.springframework.security.config.annotation.web.invoke @Configuration @EnableWebSecurity class SecurityConfig { @Bean open fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http { // ... csrf { csrfTokenRepository = CookieCsrfTokenRepository.withHttpOnlyFalse() } } return http.build() } }⁩

⁦<http> <!-- ... --> <csrf token-repository-ref="tokenRepository"/> </http> <b:bean id="tokenRepository" class="org.springframework.security.web.csrf.CookieCsrfTokenRepository" p:cookieHttpOnly="false"/>⁩

הדוגמה מגדירה במפורש את HttpOnly כ-false. זה הכרחי כדי לאפשר לפריימוורקים של JavaScript (כגון Angular) לקרוא אותו. אם אינך זקוק ליכולת לקרוא את ה-cookie עם JavaScript ישירות, אנו ממליצים להשמיט את HttpOnly (על ידי שימוש ב-new CookieCsrfTokenRepository() במקום זאת) כדי לשפר את האבטחה.

התאמה אישית של ⁦CsrfTokenRepository⁩

יכולים להיות מקרים שבהם אתה רוצה ליישם ⁦CsrfTokenRepository⁩ מותאם אישית.

לאחר שהטמעת את ממשק ⁦CsrfTokenRepository⁩, תוכל להגדיר את ⁦Spring Security⁩ להשתמש בו עם התצורה הבאה:

⁦@Configuration @EnableWebSecurity public class SecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { http // ... .csrf((csrf) -> csrf .csrfTokenRepository(new CustomCsrfTokenRepository()) ); return http.build(); } }⁩

⁦import org.springframework.security.config.annotation.web.invoke @Configuration @EnableWebSecurity class SecurityConfig { @Bean open fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http { // ... csrf { csrfTokenRepository = CustomCsrfTokenRepository() } } return http.build() } }⁩

⁦<http> <!-- ... --> <csrf token-repository-ref="tokenRepository"/> </http> <b:bean id="tokenRepository" class="example.CustomCsrfTokenRepository"/>⁩

טיפול ב-⁦CsrfToken⁩

ה-CsrfToken זמין לאפליקציה באמצעות CsrfTokenRequestHandler. רכיב זה אחראי גם על פתרון (resolving) ה-CsrfToken מכותרות HTTP או מפרמטרים של בקשות.

כברירת מחדל, נעשה שימוש ב-XorCsrfTokenRequestAttributeHandler למתן הגנת BREACH ל-CsrfToken. Spring Security מספק גם את CsrfTokenRequestAttributeHandler לביטול הגנת ה-BREACH. ניתן גם לציין מימוש מותאם אישית כדי להתאים את האסטרטגיה לטיפול ופתרון אסימונים.

שימוש ב-⁦XorCsrfTokenRequestAttributeHandler⁩ (⁦BREACH⁩)

ה-XorCsrfTokenRequestAttributeHandler הופך את ה-CsrfToken לזמין כמאפיין ב-HttpServletRequest בשם _csrf, ובנוסף מספק הגנה מפני התקפות BREACH.

ה-CsrfToken זמין גם כמאפיין בקשה תחת השם CsrfToken.class.getName(). שם זה אינו ניתן להגדרה, אך ניתן לשנות את השם _csrf באמצעות XorCsrfTokenRequestAttributeHandler#setCsrfRequestAttributeName.

יישום זה גם פותר את ערך האסימון מהבקשה ככותרת בקשה (כברירת מחדל, אחת מ-X-CSRF-TOKEN או X-XSRF-TOKEN) או כפרמטר בקשה (כברירת מחדל, _csrf).

הגנת BREACH ניתנת על ידי קידוד אקראיות לתוך ערך אסימון ה-CSRF, כדי להבטיח שה-CsrfToken המוחזר ישתנה בכל בקשה. כאשר האסימון נפתר מאוחר יותר כערך כותרת או פרמטר בקשה, הוא מפוענח כדי לקבל את האסימון הגולמי, אשר מושווה לאחר מכן ל-CsrfToken שנשמר.

⁦Spring Security⁩ מגן על האסימון ⁦CSRF⁩ מפני התקפה ⁦BREACH⁩ כברירת מחדל, כך שאין צורך בקוד נוסף. אתה יכול לציין את תצורת ברירת המחדל במפורש באמצעות התצורה הבאה:

⁦@Configuration @EnableWebSecurity public class SecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { http // ... .csrf((csrf) -> csrf .csrfTokenRequestHandler(new XorCsrfTokenRequestAttributeHandler()) ); return http.build(); } }⁩

⁦import org.springframework.security.config.annotation.web.invoke @Configuration @EnableWebSecurity class SecurityConfig { @Bean open fun securityFilterChain(http: HttpSecurity): SecurityFilterChain { http { // ... csrf { csrfTokenRequestHandler = XorCsrfTokenRequestAttributeHandler() } } return http.build() } }⁩

⁦<http> <!-- ... --> <csrf request-handler-ref="requestHandler"/> </http> <b:bean id="requestHandler" class="org.springframework.security.web.csrf.XorCsrfTokenRequestAttributeHandler"/>⁩

שימוש ב-⁦CsrfTokenRequestAttributeHandler⁩

ה-CsrfTokenRequestAttributeHandler הופך את ה-CsrfToken לזמין כמאפיין HttpServletRequest בשם _csrf.

ה-CsrfToken זמין גם כמאפיין בקשה תחת השם CsrfToken.class.getName(). שם זה אינו ניתן להגדרה, אך ניתן לשנות את השם _csrf באמצעות CsrfTokenRequestAttributeHandler#setCsrfRequestAttributeName.

יישום זה גם פותר את ערך האסימון מהבקשה ככותרת בקשה (כברירת מחדל, אחת מ-X-CSRF-TOKEN או X-XSRF-TOKEN) או כפרמטר בקשה (כברירת מחדל, _csrf).

השימוש העיקרי ב-CsrfTokenRequestAttributeHandler הוא לביטול הגנת BREACH של ה-CsrfToken, שניתן להגדיר באמצעות התצורה הבאה:

⁦@Configuration @EnableWebSecurity public class SecurityConfig { @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { http // ... .csrf((csrf) -> csrf .csrfTokenRequestHandler(new CsrfTokenRequestAttributeHandler()) ); return http.build(); } }⁩

#java#security#official-docs
קרא במקור

קריאה וכלים קשורים

אבטחת Java / Springמונחי אבטחה והסברים בעברית