Menjaga Perkhidmatan Mikro dengan Keselamatan Spring: Melaksanakan JWT
PHPz
Lepaskan: 2024-08-24 06:42:38
asal
309 orang telah melayarinya
TOKEN WEB JSON (JWT)
JWT (JSON Web Token) ialah kaedah untuk menghantar maklumat dengan selamat antara dua pihak (seperti pelanggan dan pelayan) sebagai objek JSON. Ia direka bentuk agar padat dan selamat URL, menjadikannya mudah untuk dihantar dalam URL, pengepala.
Pengepala
Muat bayar
Tandatangan
Pengepala Pengepala biasanya terdiri daripada dua bahagian: jenis token (JWT) dan algoritma tandatangan yang digunakan, seperti HMAC SHA256 atau RSA.
{ "alg":"HS256", "taip":"JWT" }
Muat bayar Di sinilah data sebenar disimpan. Ia boleh termasuk maklumat seperti ID pengguna, peranan, masa tamat tempoh dan tuntutan lain (data tentang pengguna atau sesi).
{ "e-mel":"ayushstwt@gmail.com", "nama":"Ayush" }
Tandatangan Memastikan integriti token. Ini ialah ciri keselamatan yang memastikan token tidak diubah. Ia dicipta dengan menggabungkan pengepala dan muatan yang dikodkan dengan kunci rahsia menggunakan algoritma yang ditentukan. Tandatangan membantu pelayan mengesahkan bahawa token itu sah dan tidak diusik.
Faedah JWT
Tidak Perlu Menghantar Bukti Kelayakan Berulang kali:Dengan JWT, anda tidak perlu menghantar nama pengguna dan kata laluan anda dengan setiap permintaan. Sebaliknya, anda log masuk sekali, dan pelayan memberi anda token. Anda kemudian menghantar token ini dengan setiap permintaan untuk membuktikan identiti anda, menjadikan proses lebih selamat dan cekap.
Tamat Tempoh Terbina dalam:Setiap JWT disertakan dengan masa tamat, bermakna ia hanya sah untuk tempoh tertentu. Ini mengurangkan risiko penyalahgunaan jangka panjang jika token entah bagaimana dipintas. Selepas tamat tempoh, pengguna perlu log masuk semula untuk mendapatkan token baharu, menambah lapisan keselamatan tambahan.
JWT dengan Spring Boot menguruskan pengesahan pengguna dengan selamat dengan mengeluarkan token selepas log masuk. Token ini dihantar dengan setiap permintaan, memastikan komunikasi yang selamat dan tanpa kewarganegaraan tanpa menghantar bukti kelayakan berulang kali.
Komunikasi tanpa statusbermakna pelayan tidak mengingati permintaan yang lalu. Setiap permintaan membawa semua yang diperlukan (seperti JWT), jadi pelayan tidak menyimpan maklumat sesi.
Melaksanakan JWT dalam aplikasi Java Spring Boot melibatkan beberapa langkah. Berikut ialah rangka ringkas untuk anda bermula:
1. Tambah Ketergantungan
Sertakan kebergantungan yang diperlukan dalam fail pom.xml anda
Semua kebergantungan yang kita perlukan untuk mencipta aplikasi spring-boot dengan JWT
4.0.0org.springframework.bootspring-boot-starter-parent3.3.3com.tier3Hubuser-auth-service0.0.1-SNAPSHOTuser-auth-serviceThe user-auth-service is a microservice responsible for handling user authentication and authorization within a distributed system. It is designed to manage user login, registration, and secure access to various services using robust security practices. This service implements authentication mechanisms like JSON Web Tokens (JWT) and integrates with OAuth 2.0 for third-party authentication. Built with Spring Boot, it ensures scalability, reliability, and easy integration with other microservices in the system.21org.springframework.bootspring-boot-starter-actuatororg.springframework.bootspring-boot-starter-data-jpaorg.springframework.bootspring-boot-starter-securityorg.springframework.bootspring-boot-starter-webio.jsonwebtokenjjwt-api0.12.5io.jsonwebtokenjjwt-impl0.12.5runtimeio.jsonwebtokenjjwt-jackson0.12.5runtimecom.mysqlmysql-connector-jruntimeorg.projectlomboklomboktrueorg.springframework.bootspring-boot-starter-testtestorg.springframework.securityspring-security-testtestorg.springframework.bootspring-boot-starter-validationorg.springdocspringdoc-openapi-starter-webmvc-ui2.5.0org.modelmappermodelmapper3.1.1org.springframework.bootspring-boot-maven-pluginorg.projectlomboklombok
Salin selepas log masuk
kami menggunakan pelbagai jenis kebergantungan seperti
Spring Boot Starter Actuator: 3.3.3 - Menambahkan ciri sedia pengeluaran seperti pemantauan dan pemeriksaan kesihatan.
Spring Boot Starter Data JPA: 3.3.3 - Memudahkan interaksi pangkalan data dengan sokongan JPA.
Spring Boot Starter Security: 3.3.3 - Menyediakan ciri keselamatan seperti pengesahan dan kebenaran.
Spring Boot Starter Web: 3.3.3 - Menyokong membina aplikasi web, termasuk perkhidmatan RESTful.
JJWT API: 0.12.5 - Mengendalikan penciptaan dan penghuraian JWT untuk pengurusan token yang selamat.
JJWT Impl: 0.12.5 - Melaksanakan fungsi teras JWT.
JJWT Jackson: 0.12.5 - Mendayakan penghuraian JWT JSON menggunakan Jackson.
MySQL Connector: Runtime - Menyambungkan aplikasi anda ke pangkalan data MySQL.
Lombok: Tidak dinyatakan - Mengurangkan kod boilerplate dengan anotasi.
Spring Boot Starter Test: 3.3.3 - Menyediakan sokongan ujian untuk aplikasi Spring Boot.
Ujian Keselamatan Musim Bunga: 3.3.3 - Membantu dengan menguji konfigurasi keselamatan.
Spring Boot Starter Validation: 3.3.3 - Menambah sokongan pengesahan untuk objek permintaan dan respons.
package com.tier3Hub.user_auth_service.dto; import jakarta.validation.constraints.Email; import jakarta.validation.constraints.NotBlank; import jakarta.validation.constraints.Size; import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @AllArgsConstructor @NoArgsConstructor @Data public class RegisterDTO { @NotBlank(message = "Username is required") @Size(min = 3, max = 20, message = "Username must be between 3 and 20 characters") private String username; @NotBlank(message = "Password is required") @Size(min = 8, message = "Password must be at least 8 characters") private String password; @NotBlank(message = "Email is required") @Email(message = "Email should be valid") private String email; }
*7. untuk menghantar respons tersuai daripada API kami menggunakan ResponseHandler.java *
package com.tier3Hub.user_auth_service.utils; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; import java.util.HashMap; import java.util.Map; public class ResponseHandler { public static ResponseEntity
Salin selepas log masuk
8. for storing some constants we create the class inside the utils package that is ApplicationConstants.java
package com.tier3Hub.user_auth_service.utils; public class AppConstants { public static final String[] PUBLIC_URLS = { "/v3/api-docs/**", "/swagger-ui/**", "/api/auth/register/**", "/api/auth/login/**","/api/auth/registerAdmin/**" }; }
Salin selepas log masuk
9. for converting the object one to another we use the dependency that is model mapper for configuration that we create the class inside the config package that is ApplicationConfigs.java
package com.tier3Hub.user_auth_service.config; import org.modelmapper.ModelMapper; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; @Configuration public class ApplicationConfigs { @Bean public ModelMapper modelMapper() { return new ModelMapper(); } }
Salin selepas log masuk
** This is the basic setup that we do for every spring-boot application we create now securing the rest endpoint with JWT we started. **
now inside the security package we create the class called JWTFilter.java
The JWTFilter is a custom Spring Security filter that intercepts HTTP requests to validate JWTs. It checks for the "Authorization" header, extracts the token, and retrieves the username. If the token is valid, it creates an authentication token with user details and sets it in the security context, allowing the application to recognize the authenticated user for further processing.
The JWTUtil class manages JWT operations, including extracting usernames and expiration dates from tokens. It generates new tokens using a secret key and validates existing tokens by checking their expiration. The class uses HMAC for signing and includes methods to parse claims and determine if tokens are expired, ensuring secure authentication and authorization in the application.
*configure the Spring security and add some modifictaion we create the class SecurityConfig.java *
The SecurityConfig class sets up security for the application using Spring Security. It defines access rules, allowing public endpoints while restricting others based on user roles. The class incorporates a JWT filter to validate tokens and uses BCrypt for password encoding. It also configures an authentication manager with a custom user details service for secure user authentication.
The securityFilterChain method configures access rules for different API endpoints in the Spring application. It permits public URLs and applies role-based access control for user and admin roles. Role-based authentication restricts resource access based on user roles (e.g., USER, ADMIN). In Spring Boot, you define roles and configure security settings in the SecurityConfig class to specify access permissions. During user registration, assign roles, and use annotations like @PreAuthorize to enforce role checks in controllers. This approach enhances security, allows easy permission management, and simplifies user access rights as the application scales. Implementing role-based auth provides flexibility and maintainability for your user management system. CSRF protection is disabled, and a custom JWT filter is added to authenticate requests based on JSON Web Tokens, ensuring secure and controlled access to resources.
configureGlobal method handle configures global authentication settings in a Spring application. It uses a custom user details service for loading user data and a BCrypt password encoder for secure password hashing. Additionally, it provides an AuthenticationManager bean for handling authentication processes, ensuring a secure and efficient user authentication system that leverages strong password management practices.
This login method in the AuthController handles user login requests. It takes a LoginDTO containing the username and password, validates them, and attempts authentication using the AuthenticationManager. Upon successful authentication, it retrieves user details and generates a JWT token using the JWTUtil class. The token is then included in a LoginResponse object and returned with a success message. If authentication fails, it catches the exception and returns a "Incorrect username or password" response with a 400 status code.
generateToken(String username):This method creates an empty claims map and calls the createToken method with the username as the subject. It serves as the entry point for token generation.
c*reateToken(Map claims, String subject):* This method builds the JWT using the Jwts.builder(). It sets the claims, subject, and token metadata, such as issue date and expiration time (set to 5 minutes). The token is then signed with a secret key and compacted into a string format for transmission.
Testing
now we run the application
and hit the URL here our application is runing on 8000 port
http://localhost:8000/swagger-ui/index.html
Menggunakan Swagger dalam projek anda meningkatkan dokumentasi dan ujian API. Ia menyediakan antara muka mesra pengguna untuk pembangun meneroka API anda, memahami struktur permintaan/tindak balas dan menguji titik akhir terus daripada dokumentasi. Dengan menyepadukan Swagger, anda mendayakan penjanaan automatik dokumen API berdasarkan anotasi kod anda, menjadikannya lebih mudah untuk pembangun bahagian hadapan dan belakang untuk bekerjasama dengan cekap.
mula-mula kami daftarkan pengguna
kami dapat sambutan seperti ini
selepas itu kami login pengguna
kami dapat sambutan seperti ini
Kesimpulan
Projek ini melaksanakan pengesahan berasaskan peranan menggunakan JWT (Token Web JSON) dalam aplikasi Spring Boot. Ia menampilkan mekanisme pengesahan selamat di mana pengguna boleh mendaftar dan log masuk, menerima JWT yang memberikan akses berdasarkan peranan yang diberikan mereka (seperti USER atau ADMIN). Kelas SecurityConfig mengkonfigurasi kebenaran akses, memastikan titik akhir awam boleh diakses oleh semua orang sambil mengehadkan operasi sensitif kepada pengguna yang dibenarkan sahaja. Kelas JWTUtil mengendalikan penciptaan token, pengesahan dan pengekstrakan pengguna. Secara keseluruhan, persediaan ini meningkatkan keselamatan, membolehkan kawalan akses yang lancar dan mantap merentas aplikasi.
Projek ini menggunakan rangka kerja keselamatan komprehensif yang memanfaatkan Spring Security untuk pengesahan dan kebenaran pengguna. AuthController memudahkan pendaftaran dan log masuk pengguna, menghasilkan JWT apabila pengesahan berjaya. Aplikasi ini menggunakan JWTFilter untuk memintas permintaan dan mengesahkan token, memastikan bahawa hanya pengguna yang disahkan boleh mengakses sumber yang dilindungi. Dengan menyepadukan kawalan akses berasaskan peranan, projek ini menyediakan sistem pengurusan pengguna yang fleksibel dan selamat. Reka bentuk ini bukan sahaja meningkatkan keselamatan tetapi juga meningkatkan pengalaman pengguna dengan meminimumkan keperluan untuk log masuk berulang. Secara keseluruhannya, ia meletakkan asas yang kukuh untuk membina perkhidmatan mikro berskala dan selamat.
Anda boleh menerokai kod sumber lengkap untuk Perkhidmatan Pengesahan Pengguna pada repositori GitHub saya. Projek ini mempamerkan pelbagai ciri seperti pendaftaran pengguna, log masuk dan akses selamat menggunakan JWT untuk pengesahan. Jangan ragu untuk menyemaknya, menyumbang atau menggunakannya sebagai rujukan untuk projek anda sendiri!
Bagi mereka yang berminat untuk menyelam lebih dalam ke dalam JSON Web Token (JWT), saya syorkan melawati jwt.io. Sumber ini menyediakan maklumat komprehensif tentang JWT, termasuk cara ia berfungsi, strukturnya dan contoh praktikal. Ia merupakan titik permulaan yang sangat baik untuk memahami pengesahan dan kebenaran berasaskan token, yang penting untuk aplikasi web moden. Sama ada anda seorang pemula atau ingin menyegarkan pengetahuan anda, jwt.io menawarkan cerapan berharga dalam mengurus sesi pengguna dengan selamat.
Atas ialah kandungan terperinci Menjaga Perkhidmatan Mikro dengan Keselamatan Spring: Melaksanakan JWT. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!
Kandungan artikel ini disumbangkan secara sukarela oleh netizen, dan hak cipta adalah milik pengarang asal. Laman web ini tidak memikul tanggungjawab undang-undang yang sepadan. Jika anda menemui sebarang kandungan yang disyaki plagiarisme atau pelanggaran, sila hubungi admin@php.cn