├── .mvn └── wrapper │ ├── maven-wrapper.jar │ ├── maven-wrapper.properties │ └── MavenWrapperDownloader.java ├── src ├── main │ ├── resources │ │ ├── db │ │ │ ├── changelog.yaml │ │ │ └── 01 │ │ │ │ ├── changelog.yaml │ │ │ │ └── 01_create-users-table.yaml │ │ └── application.properties │ └── java │ │ └── com │ │ └── thegeekyasian │ │ └── security │ │ ├── enums │ │ ├── TokenType.java │ │ └── Role.java │ │ ├── exceptions │ │ └── UnauthorizedException.java │ │ ├── SpringSecurityApplication.java │ │ ├── services │ │ ├── IAuthenticationService.java │ │ ├── IUserService.java │ │ ├── UserDetailsServiceImpl.java │ │ ├── AuthenticationService.java │ │ └── UserService.java │ │ ├── controllers │ │ ├── resp │ │ │ ├── ErrorResponseWrapper.java │ │ │ ├── ResponseWrapper.java │ │ │ └── CommonErrorHandler.java │ │ ├── UserController.java │ │ └── AuthenticationController.java │ │ ├── persistence │ │ ├── repositories │ │ │ └── UserRepository.java │ │ └── entities │ │ │ ├── BaseEntity.java │ │ │ └── User.java │ │ ├── models │ │ ├── RefreshTokenRequest.java │ │ ├── RegistrationRequest.java │ │ ├── AuthenticationRequest.java │ │ ├── ChangePasswordRequest.java │ │ └── AuthResponse.java │ │ ├── SecurityAuthenticationEntryPoint.java │ │ ├── validators │ │ ├── annotations │ │ │ ├── ValidateRegistrationRequest.java │ │ │ └── ValidateChangePasswordRequest.java │ │ ├── ChangePasswordRequestValidator.java │ │ └── RegistrationReqValidator.java │ │ ├── filters │ │ └── AuthenticationFilter.java │ │ ├── config │ │ └── WebSecurityConfig.java │ │ └── utils │ │ └── AuthenticationUtils.java └── test │ ├── resources │ └── application-test.properties │ └── java │ └── com │ └── thegeekyasian │ └── security │ ├── SpringSecurityApplicationTests.java │ ├── BaseServiceTest.java │ └── services │ ├── AuthenticationServiceTest.java │ └── UserServiceTest.java ├── .gitignore ├── .github └── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md ├── README.md ├── pom.xml ├── postman-collection.json ├── mvnw.cmd ├── mvnw └── LICENSE /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/thegeekyasian/spring-security-jwt-mysql-microservice/HEAD/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /src/main/resources/db/changelog.yaml: -------------------------------------------------------------------------------- 1 | databaseChangeLog: 2 | - include: 3 | file: 01/changelog.yaml 4 | relativeToChangelogFile: true -------------------------------------------------------------------------------- /src/main/resources/db/01/changelog.yaml: -------------------------------------------------------------------------------- 1 | databaseChangeLog: 2 | - include: 3 | file: 01_create-users-table.yaml 4 | relativeToChangelogFile: true -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/enums/TokenType.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.enums; 2 | 3 | public enum TokenType { 4 | 5 | AUTH, 6 | REFRESH 7 | } 8 | -------------------------------------------------------------------------------- /src/test/resources/application-test.properties: -------------------------------------------------------------------------------- 1 | 2 | spring.security.jwt-secret=change-it 3 | spring.security.jwt-expiration-in-seconds=86400 4 | spring.security.jwt-refresh-token-expiration-in-seconds=604800 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | README.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/g 6 | 7 | ### IntelliJ IDEA ### 8 | .idea 9 | *.iws 10 | *.iml 11 | *.ipr 12 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/enums/Role.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.enums; 2 | 3 | /** 4 | * @author thegeekyasian.com 5 | */ 6 | public enum Role { 7 | ROLE_ADMIN, 8 | ROLE_USER 9 | } 10 | -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.2/apache-maven-3.8.2-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar 3 | -------------------------------------------------------------------------------- /src/test/java/com/thegeekyasian/security/SpringSecurityApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security; 2 | 3 | import org.junit.jupiter.api.Test; 4 | 5 | import org.springframework.boot.test.context.SpringBootTest; 6 | 7 | @SpringBootTest 8 | class SpringSecurityApplicationTests { 9 | 10 | @Test 11 | void contextLoads() { 12 | } 13 | 14 | } 15 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/exceptions/UnauthorizedException.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.exceptions; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.Getter; 5 | 6 | /** 7 | * @author thegeekyasian.com 8 | */ 9 | @Getter 10 | @AllArgsConstructor 11 | public class UnauthorizedException extends RuntimeException { 12 | private final String message; 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/SpringSecurityApplication.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class SpringSecurityApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(SpringSecurityApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/services/IAuthenticationService.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.services; 2 | 3 | import com.thegeekyasian.security.models.AuthResponse; 4 | import com.thegeekyasian.security.models.AuthenticationRequest; 5 | 6 | import org.springframework.stereotype.Service; 7 | 8 | /** 9 | * @author thegeekyasian.com 10 | */ 11 | @Service 12 | public interface IAuthenticationService { 13 | 14 | Object authenticateUser(String username, String password); 15 | 16 | AuthResponse authenticateUser(AuthenticationRequest authenticationRequest); 17 | } 18 | -------------------------------------------------------------------------------- /src/test/java/com/thegeekyasian/security/BaseServiceTest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security; 2 | 3 | import org.junit.jupiter.api.extension.ExtendWith; 4 | 5 | import org.springframework.boot.test.context.SpringBootTest; 6 | import org.springframework.test.context.TestPropertySource; 7 | import org.springframework.test.context.junit.jupiter.SpringExtension; 8 | 9 | /** 10 | * @author thegeekyasian.com 11 | */ 12 | @SpringBootTest 13 | @ExtendWith(SpringExtension.class) 14 | @TestPropertySource(locations="classpath:application-test.properties") 15 | public class BaseServiceTest { 16 | } 17 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/controllers/resp/ErrorResponseWrapper.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.controllers.resp; 2 | 3 | import lombok.AllArgsConstructor; 4 | import lombok.Builder; 5 | import lombok.Data; 6 | import lombok.NoArgsConstructor; 7 | 8 | /** 9 | * @author thegeekyasian.com 10 | */ 11 | @Data 12 | @Builder 13 | @NoArgsConstructor 14 | @AllArgsConstructor 15 | public class ErrorResponseWrapper { 16 | 17 | @Builder.Default 18 | private Boolean status = false; 19 | 20 | private String result; 21 | 22 | private Object message; 23 | 24 | private Object data; 25 | } -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/persistence/repositories/UserRepository.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.persistence.repositories; 2 | 3 | import java.util.Optional; 4 | 5 | import com.thegeekyasian.security.persistence.entities.User; 6 | 7 | import org.springframework.data.jpa.repository.JpaRepository; 8 | import org.springframework.stereotype.Repository; 9 | 10 | /** 11 | * @author thegeekyasian.com 12 | */ 13 | @Repository 14 | public interface UserRepository extends JpaRepository { 15 | 16 | User getByUsername(String username); 17 | 18 | Optional findByUsername(String username); 19 | } 20 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See an error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/models/RefreshTokenRequest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.models; 2 | 3 | import javax.validation.constraints.NotBlank; 4 | 5 | import com.fasterxml.jackson.annotation.JsonProperty; 6 | import lombok.AllArgsConstructor; 7 | import lombok.Data; 8 | import lombok.NoArgsConstructor; 9 | import lombok.experimental.SuperBuilder; 10 | 11 | /** 12 | * @author thegeekyasian.com 13 | */ 14 | @Data 15 | @SuperBuilder 16 | @NoArgsConstructor 17 | @AllArgsConstructor 18 | public class RefreshTokenRequest { 19 | 20 | @NotBlank(message = "refresh_token must provided.") 21 | @JsonProperty("refresh_token") 22 | private String refreshToken; 23 | } 24 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/controllers/resp/ResponseWrapper.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.controllers.resp; 2 | 3 | import com.fasterxml.jackson.annotation.JsonProperty; 4 | import lombok.AllArgsConstructor; 5 | import lombok.Builder; 6 | import lombok.Data; 7 | import lombok.NoArgsConstructor; 8 | 9 | /** 10 | * @author thegeekyasian.com 11 | */ 12 | @Data 13 | @Builder 14 | @NoArgsConstructor 15 | @AllArgsConstructor 16 | public class ResponseWrapper { 17 | 18 | @Builder.Default 19 | @JsonProperty(value = "status") 20 | private boolean status = true; 21 | 22 | @JsonProperty(value = "data") 23 | private Object data; 24 | 25 | public static ResponseWrapper from(Object data) { 26 | return ResponseWrapper.builder() 27 | .status(true) 28 | .data(data) 29 | .build(); 30 | } 31 | } -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/models/RegistrationRequest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.models; 2 | 3 | import javax.validation.constraints.NotBlank; 4 | 5 | import com.fasterxml.jackson.annotation.JsonProperty; 6 | import com.thegeekyasian.security.validators.annotations.ValidateRegistrationRequest; 7 | import lombok.AllArgsConstructor; 8 | import lombok.Data; 9 | import lombok.NoArgsConstructor; 10 | import lombok.experimental.SuperBuilder; 11 | 12 | /** 13 | * @author thegeekyasian.com 14 | */ 15 | @Data 16 | @SuperBuilder 17 | @NoArgsConstructor 18 | @AllArgsConstructor 19 | @ValidateRegistrationRequest 20 | public class RegistrationRequest extends AuthenticationRequest { 21 | 22 | @NotBlank(message = "confirm_password must provided.") 23 | @JsonProperty("confirm_password") 24 | private String confirmPassword; 25 | } 26 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | spring.application.name=Security app by TheGeekyAsian.com 2 | server.port=${SERVER_PORT:9000} 3 | 4 | spring.datasource.username=${DATASOURCE_USERNAME:root} 5 | spring.datasource.password=${DATASOURCE_PASSWORD:password} 6 | spring.datasource.url=${DATASOURCE_URL:jdbc:mysql://localhost:3306/security?createDatabaseIfNotExist=true} 7 | spring.datasource.driverClassName=com.mysql.jdbc.Driver 8 | spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect 9 | 10 | spring.security.jwt-secret=${JWT_SECRET:change-it} 11 | # Expiration time: 1 day in seconds 12 | spring.security.jwt-expiration-in-seconds=${JWT_EXPIRATION_SECONDS:86400} 13 | # Expiration time: 1 week in seconds 14 | spring.security.jwt-refresh-token-expiration-in-seconds=${REFRESH_TOKEN_EXPIRATION_SECONDS:604800} 15 | 16 | spring.liquibase.change-log=classpath:db/changelog.yaml -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/services/IUserService.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.services; 2 | 3 | import java.util.List; 4 | 5 | import com.thegeekyasian.security.models.AuthResponse; 6 | import com.thegeekyasian.security.models.ChangePasswordRequest; 7 | import com.thegeekyasian.security.models.RefreshTokenRequest; 8 | import com.thegeekyasian.security.models.RegistrationRequest; 9 | import com.thegeekyasian.security.persistence.entities.User; 10 | 11 | /** 12 | * @author thegeekyasian.com 13 | */ 14 | public interface IUserService { 15 | 16 | AuthResponse registerUser(RegistrationRequest registrationRequest); 17 | 18 | AuthResponse changePassword(ChangePasswordRequest changePasswordRequest); 19 | 20 | AuthResponse refreshToken(RefreshTokenRequest refreshTokenRequest); 21 | 22 | User getUser(String username); 23 | 24 | List getAllUsers(); 25 | } 26 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/models/AuthenticationRequest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.models; 2 | 3 | import javax.validation.constraints.NotBlank; 4 | 5 | import lombok.AllArgsConstructor; 6 | import lombok.Data; 7 | import lombok.NoArgsConstructor; 8 | import lombok.experimental.SuperBuilder; 9 | 10 | /** 11 | * @author thegeekyasian.com 12 | */ 13 | @Data 14 | @SuperBuilder 15 | @NoArgsConstructor 16 | @AllArgsConstructor 17 | public class AuthenticationRequest { 18 | 19 | @NotBlank(message = "username must be provided.") 20 | private String username; 21 | 22 | @NotBlank(message = "password must be provided.") 23 | private String password; 24 | 25 | public static AuthenticationRequest from(String username, String password) { 26 | 27 | return AuthenticationRequest.builder() 28 | .username(username) 29 | .password(password) 30 | .build(); 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/SecurityAuthenticationEntryPoint.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security; 2 | 3 | import java.io.IOException; 4 | import java.io.Serializable; 5 | 6 | import javax.servlet.http.HttpServletRequest; 7 | import javax.servlet.http.HttpServletResponse; 8 | 9 | import org.springframework.security.core.AuthenticationException; 10 | import org.springframework.security.web.AuthenticationEntryPoint; 11 | import org.springframework.stereotype.Component; 12 | 13 | /** 14 | * @author thegeekyasian.com 15 | */ 16 | @Component 17 | public class SecurityAuthenticationEntryPoint implements AuthenticationEntryPoint, Serializable { 18 | 19 | @Override 20 | public void commence(HttpServletRequest request, HttpServletResponse response, 21 | AuthenticationException authException) throws IOException { 22 | response.sendError(HttpServletResponse.SC_UNAUTHORIZED, "Unauthorized"); 23 | } 24 | } -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/validators/annotations/ValidateRegistrationRequest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.validators.annotations; 2 | 3 | import java.lang.annotation.ElementType; 4 | import java.lang.annotation.Retention; 5 | import java.lang.annotation.RetentionPolicy; 6 | import java.lang.annotation.Target; 7 | 8 | import javax.validation.Constraint; 9 | import javax.validation.Payload; 10 | 11 | import com.thegeekyasian.security.validators.RegistrationReqValidator; 12 | 13 | /** 14 | * @author thegeekyasian.com 15 | */ 16 | @Target(ElementType.TYPE) 17 | @Retention(RetentionPolicy.RUNTIME) 18 | @Constraint(validatedBy = RegistrationReqValidator.class) 19 | public @interface ValidateRegistrationRequest { 20 | 21 | String message() default "Invalid registration request."; 22 | 23 | Class[] groups() default {}; 24 | 25 | Class[] payload() default {}; 26 | 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/validators/annotations/ValidateChangePasswordRequest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.validators.annotations; 2 | 3 | import java.lang.annotation.ElementType; 4 | import java.lang.annotation.Retention; 5 | import java.lang.annotation.RetentionPolicy; 6 | import java.lang.annotation.Target; 7 | 8 | import javax.validation.Constraint; 9 | import javax.validation.Payload; 10 | 11 | import com.thegeekyasian.security.validators.ChangePasswordRequestValidator; 12 | 13 | /** 14 | * @author thegeekyasian.com 15 | */ 16 | @Target(ElementType.TYPE) 17 | @Retention(RetentionPolicy.RUNTIME) 18 | @Constraint(validatedBy = ChangePasswordRequestValidator.class) 19 | public @interface ValidateChangePasswordRequest { 20 | 21 | String message() default "Invalid change password request."; 22 | 23 | Class[] groups() default {}; 24 | 25 | Class[] payload() default {}; 26 | 27 | } 28 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/models/ChangePasswordRequest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.models; 2 | 3 | import javax.validation.constraints.NotBlank; 4 | 5 | import com.fasterxml.jackson.annotation.JsonProperty; 6 | import com.thegeekyasian.security.validators.annotations.ValidateChangePasswordRequest; 7 | import lombok.AllArgsConstructor; 8 | import lombok.Builder; 9 | import lombok.Data; 10 | import lombok.NoArgsConstructor; 11 | 12 | /** 13 | * @author thegeekyasian.com 14 | */ 15 | @Data 16 | @Builder 17 | @NoArgsConstructor 18 | @AllArgsConstructor 19 | @ValidateChangePasswordRequest 20 | public class ChangePasswordRequest { 21 | 22 | @NotBlank(message = "password must be provided.") 23 | private String password; 24 | 25 | @NotBlank(message = "new_password must provided.") 26 | @JsonProperty("new_password") 27 | private String newPassword; 28 | 29 | @NotBlank(message = "confirm_new_password must provided.") 30 | @JsonProperty("confirm_new_password") 31 | private String confirmNewPassword; 32 | } 33 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/models/AuthResponse.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.models; 2 | 3 | import com.fasterxml.jackson.annotation.JsonProperty; 4 | import lombok.AllArgsConstructor; 5 | import lombok.Builder; 6 | import lombok.Data; 7 | import lombok.NoArgsConstructor; 8 | 9 | import static com.thegeekyasian.security.utils.AuthenticationUtils.SecurityConstants.HEADER_REQUEST_TOKEN_VALUE_PREFIX; 10 | 11 | /** 12 | * @author thegeekyasian.com 13 | */ 14 | @Data 15 | @Builder 16 | @NoArgsConstructor 17 | @AllArgsConstructor 18 | public class AuthResponse { 19 | 20 | private String type; 21 | 22 | @JsonProperty(value = "auth_token") 23 | private String authToken; 24 | 25 | @JsonProperty(value = "refresh_token") 26 | private String refreshToken; 27 | 28 | public static AuthResponse from(String authToken, String refreshToken) { 29 | return AuthResponse 30 | .builder() 31 | .type(HEADER_REQUEST_TOKEN_VALUE_PREFIX.trim()) 32 | .authToken(authToken) 33 | .refreshToken(refreshToken) 34 | .build(); 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/services/UserDetailsServiceImpl.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.services; 2 | 3 | import com.thegeekyasian.security.persistence.repositories.UserRepository; 4 | import lombok.RequiredArgsConstructor; 5 | 6 | import org.springframework.security.core.userdetails.UserDetails; 7 | import org.springframework.security.core.userdetails.UserDetailsService; 8 | import org.springframework.security.core.userdetails.UsernameNotFoundException; 9 | import org.springframework.stereotype.Service; 10 | 11 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.USER_NOT_FOUND_ERROR; 12 | 13 | /** 14 | * @author thegeekyasian.com 15 | */ 16 | @Service 17 | @RequiredArgsConstructor 18 | public class UserDetailsServiceImpl implements UserDetailsService { 19 | 20 | private final UserRepository userRepository; 21 | 22 | @Override 23 | public UserDetails loadUserByUsername(String username) { 24 | return userRepository 25 | .findByUsername(username) 26 | .orElseThrow(() -> 27 | new UsernameNotFoundException(USER_NOT_FOUND_ERROR)); 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /src/main/resources/db/01/01_create-users-table.yaml: -------------------------------------------------------------------------------- 1 | databaseChangeLog: 2 | - changeSet: 3 | id: 01-01-01 4 | author: thegeekyasian 5 | changes: 6 | - createTable: 7 | tableName: users 8 | columns: 9 | - column: 10 | name: id 11 | type: BIGINT 12 | constraints: 13 | primaryKey: true 14 | nullable: false 15 | autoIncrement: true 16 | 17 | - column: 18 | name: created_at 19 | type: DATETIME 20 | 21 | - column: 22 | name: updated_at 23 | type: DATETIME 24 | 25 | - column: 26 | name: username 27 | type: VARCHAR(75) 28 | constraints: 29 | nullable: false 30 | unique: true 31 | 32 | - column: 33 | name: password 34 | type: VARCHAR(150) 35 | 36 | - column: 37 | name: user_role 38 | type: VARCHAR(50) 39 | 40 | - column: 41 | name: password_updated_at 42 | type: DATETIME -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/services/AuthenticationService.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.services; 2 | 3 | import com.thegeekyasian.security.models.AuthResponse; 4 | import com.thegeekyasian.security.models.AuthenticationRequest; 5 | import com.thegeekyasian.security.persistence.entities.User; 6 | import com.thegeekyasian.security.utils.AuthenticationUtils; 7 | import lombok.RequiredArgsConstructor; 8 | 9 | import org.springframework.security.authentication.AuthenticationManager; 10 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; 11 | import org.springframework.stereotype.Service; 12 | 13 | 14 | /** 15 | * @author thegeekyasian.com 16 | */ 17 | @Service 18 | @RequiredArgsConstructor 19 | public class AuthenticationService implements IAuthenticationService { 20 | 21 | private final AuthenticationManager authenticationManager; 22 | 23 | @Override 24 | public Object authenticateUser(String username, String password) { 25 | return authenticationManager.authenticate( 26 | new UsernamePasswordAuthenticationToken(username, password)); 27 | } 28 | 29 | /** 30 | * Authenticate user 31 | *

32 | * The method uses the username and password from the request 33 | *

34 | * */ 35 | @Override 36 | public AuthResponse authenticateUser(AuthenticationRequest authenticationRequest) { 37 | 38 | User user = (User) authenticationManager.authenticate( 39 | new UsernamePasswordAuthenticationToken( 40 | authenticationRequest.getUsername(), 41 | authenticationRequest.getPassword())) 42 | .getPrincipal(); 43 | 44 | return AuthResponse.from(AuthenticationUtils.generateAuthToken(user), 45 | AuthenticationUtils.generateRefreshToken(user)); 46 | } 47 | } 48 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Spring Security Microservice using JWT and MySQL 2 | 3 | ### Background 4 | 5 | This is an open source, production-ready application that provides role-based user 6 | authentication. The application uses Spring Security in combination with JWT to 7 | authenticate users. 8 | 9 | The application is ready to be used for your security and can be extended easily. 10 | 11 | ### Pre-requisite 12 | 13 | The application requires the below to tools installed to run: 14 | - Java 8 15 | - Maven 16 | - MySQL 17 | 18 | ### Requests / Endpoints 19 | 20 | The application exposes various endpoints. A postman collection is added in the project within `postman-collection.json` file. 21 | 22 | Here is the list of all the endpoints: 23 | 24 | 1. Register User (POST) 25 | 26 | URI: `/auth/register` 27 | ``` 28 | { 29 | "username" : "thegeekyasian", 30 | "password" : "password", 31 | "confirm_password" : "password" 32 | } 33 | ``` 34 | 35 | 2. Login User (POST) 36 | 37 | URI: `/auth/login` 38 | ``` 39 | { 40 | "username" : "thegeekyasian", 41 | "password" : "password" 42 | } 43 | ``` 44 | 45 | 3. Refresh Token (POST) 46 | 47 | URI: `/auth/refresh` 48 | ``` 49 | { 50 | "refresh_token" : "REFRESH_TOKEN_HERE" 51 | } 52 | ``` 53 | 54 | 4. Change Password (POST) 55 | 56 | URI: `/users/change-password` 57 | 58 | Headers: `Authorization: Bearer AUTH_TOKEN_HERE` 59 | ``` 60 | { 61 | "password" : "current_password", 62 | "new_password" : "updated_password", 63 | "confirm_new_password" : "updated_password" 64 | } 65 | ``` 66 | 67 | 5. Get Current User (GET) 68 | 69 | URI: `/users/me` 70 | 71 | Headers: `Authorization: Bearer AUTH_TOKEN_HERE` 72 | 73 | ### Help 74 | 75 | For any questions, assistance or to report any issues, please reach out to hello@thegeekyasian.com -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/persistence/entities/BaseEntity.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.persistence.entities; 2 | 3 | import java.io.Serializable; 4 | import java.time.ZonedDateTime; 5 | 6 | import javax.persistence.Column; 7 | import javax.persistence.EntityListeners; 8 | import javax.persistence.MappedSuperclass; 9 | 10 | import com.fasterxml.jackson.annotation.JsonFormat; 11 | import com.fasterxml.jackson.annotation.JsonIgnoreProperties; 12 | import com.fasterxml.jackson.annotation.JsonProperty; 13 | import lombok.AccessLevel; 14 | import lombok.Getter; 15 | import lombok.Setter; 16 | import org.hibernate.annotations.CreationTimestamp; 17 | import org.hibernate.annotations.UpdateTimestamp; 18 | 19 | import org.springframework.data.jpa.domain.support.AuditingEntityListener; 20 | import org.springframework.format.annotation.DateTimeFormat; 21 | 22 | @Getter 23 | @Setter 24 | @MappedSuperclass 25 | @EntityListeners(AuditingEntityListener.class) 26 | @JsonIgnoreProperties(value = { "createdAt", "updatedAt", "passwordUpdatedAt" }, 27 | allowGetters = true) 28 | public class BaseEntity implements Serializable { 29 | 30 | 31 | @Setter(AccessLevel.NONE) 32 | @JsonProperty(access = JsonProperty.Access.READ_ONLY) 33 | @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss'Z'") 34 | @Column(name = "created_at", nullable = false, updatable = false, 35 | columnDefinition = "TIMESTAMP") 36 | @CreationTimestamp 37 | @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) 38 | private ZonedDateTime createdAt; 39 | 40 | @Column(name = "updated_at", nullable = false, columnDefinition = "TIMESTAMP") 41 | @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss'Z'") 42 | @UpdateTimestamp 43 | @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) 44 | private ZonedDateTime updatedAt; 45 | } -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/controllers/UserController.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.controllers; 2 | 3 | import javax.validation.Valid; 4 | 5 | import com.thegeekyasian.security.controllers.resp.ResponseWrapper; 6 | import com.thegeekyasian.security.models.ChangePasswordRequest; 7 | import com.thegeekyasian.security.services.IUserService; 8 | import com.thegeekyasian.security.utils.AuthenticationUtils; 9 | import lombok.RequiredArgsConstructor; 10 | 11 | import org.springframework.http.ResponseEntity; 12 | import org.springframework.web.bind.annotation.GetMapping; 13 | import org.springframework.web.bind.annotation.PostMapping; 14 | import org.springframework.web.bind.annotation.RequestBody; 15 | import org.springframework.web.bind.annotation.RequestMapping; 16 | import org.springframework.web.bind.annotation.RestController; 17 | 18 | /** 19 | * @author thegeekyasian.com 20 | */ 21 | @RestController 22 | @RequestMapping(value = "users") 23 | @RequiredArgsConstructor 24 | public class UserController { 25 | 26 | private final IUserService userService; 27 | 28 | /** 29 | * Change password 30 | *

31 | * Updates user's password to the latest one. 32 | * Change-password succeeds only if the user is authenticated. 33 | *

34 | * 35 | * @param changePasswordRequest The ChangePasswordRequest holds password 36 | * (current password), newPassword and a confirmNewPassword parameters. 37 | * @return The function returns ResponseEntity having the ResponseWrapper. 38 | * The success response holds a JWT token. 39 | */ 40 | @PostMapping(value = "change-password") 41 | public ResponseEntity changePassword( 42 | @RequestBody @Valid ChangePasswordRequest changePasswordRequest) { 43 | return ResponseEntity.ok(ResponseWrapper 44 | .from(userService.changePassword(changePasswordRequest))); 45 | } 46 | 47 | @GetMapping(value = "me") 48 | public ResponseEntity getCurrentUser() { 49 | return ResponseEntity 50 | .ok() 51 | .body(ResponseWrapper.from(AuthenticationUtils.getCurrentUser())); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/validators/ChangePasswordRequestValidator.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.validators; 2 | 3 | import java.util.concurrent.atomic.AtomicReference; 4 | 5 | import javax.validation.ConstraintValidator; 6 | import javax.validation.ConstraintValidatorContext; 7 | 8 | import com.thegeekyasian.security.models.ChangePasswordRequest; 9 | import com.thegeekyasian.security.persistence.repositories.UserRepository; 10 | import com.thegeekyasian.security.validators.annotations.ValidateChangePasswordRequest; 11 | import lombok.RequiredArgsConstructor; 12 | import lombok.extern.slf4j.Slf4j; 13 | 14 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.UNMATCHED_PASSWORDS_ERROR; 15 | import static org.springframework.util.StringUtils.hasText; 16 | 17 | /** 18 | * RegistrationReqValidator 19 | *

20 | * Validates the RegistrationRequest before registering a user. 21 | * The validation has two parts: 22 | *

23 | *

24 | * 1. Validate if the provided password and confirm-password, both are equal. 25 | *

26 | *

27 | * 2. Validate if the user with that username does exist. 28 | *

29 | * 30 | *

31 | * If any of the above conditions is false, the validation fails. 32 | *

33 | * 34 | * @author thegeekyasian.com 35 | */ 36 | @Slf4j 37 | @RequiredArgsConstructor 38 | public class ChangePasswordRequestValidator 39 | implements ConstraintValidator { 41 | 42 | private final UserRepository userRepository; 43 | 44 | @Override 45 | public void initialize(ValidateChangePasswordRequest validateChangePasswordRequest) { 46 | } 47 | 48 | @Override 49 | public boolean isValid(ChangePasswordRequest changePasswordRequest, 50 | ConstraintValidatorContext constraintValidatorContext) { 51 | 52 | AtomicReference isValid = new AtomicReference<>(Boolean.TRUE); 53 | constraintValidatorContext.disableDefaultConstraintViolation(); 54 | 55 | // If the new-password and confirm-password do not match, return error. 56 | if (hasText(changePasswordRequest.getNewPassword()) 57 | && !changePasswordRequest.getNewPassword() 58 | .equals(changePasswordRequest.getConfirmNewPassword())) { 59 | 60 | isValid.set(Boolean.FALSE); 61 | constraintValidatorContext.buildConstraintViolationWithTemplate( 62 | UNMATCHED_PASSWORDS_ERROR).addConstraintViolation(); 63 | } 64 | 65 | return isValid.get(); 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/persistence/entities/User.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.persistence.entities; 2 | 3 | import java.util.Collection; 4 | import java.util.Date; 5 | 6 | import javax.persistence.Column; 7 | import javax.persistence.Entity; 8 | import javax.persistence.EnumType; 9 | import javax.persistence.Enumerated; 10 | import javax.persistence.GeneratedValue; 11 | import javax.persistence.GenerationType; 12 | import javax.persistence.Id; 13 | import javax.persistence.Table; 14 | 15 | import com.fasterxml.jackson.annotation.JsonIgnore; 16 | import com.thegeekyasian.security.enums.Role; 17 | import lombok.AccessLevel; 18 | import lombok.AllArgsConstructor; 19 | import lombok.Builder; 20 | import lombok.Getter; 21 | import lombok.NoArgsConstructor; 22 | import lombok.Setter; 23 | 24 | import org.springframework.format.annotation.DateTimeFormat; 25 | import org.springframework.security.core.GrantedAuthority; 26 | import org.springframework.security.core.authority.SimpleGrantedAuthority; 27 | import org.springframework.security.core.userdetails.UserDetails; 28 | 29 | import static java.util.Collections.singletonList; 30 | 31 | /** 32 | * @author thegeekyasian.com 33 | */ 34 | @Getter 35 | @Setter 36 | @Builder 37 | @Entity 38 | @NoArgsConstructor 39 | @AllArgsConstructor 40 | @Table(name = "users") 41 | public class User extends BaseEntity implements UserDetails { 42 | 43 | @Id 44 | @Column(name = "id") 45 | @GeneratedValue(strategy = GenerationType.IDENTITY) 46 | private Long id; 47 | 48 | @Column(name = "username") 49 | private String username; 50 | 51 | @JsonIgnore 52 | @Column(name = "password") 53 | private String password; 54 | 55 | @JsonIgnore 56 | @Column(name = "user_role") 57 | @Enumerated(EnumType.STRING) 58 | private Role role; 59 | 60 | @JsonIgnore 61 | @Setter(AccessLevel.NONE) 62 | @Column(name = "password_updated_at", nullable = false, 63 | columnDefinition = "TIMESTAMP") 64 | @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) 65 | private Date passwordUpdatedAt; 66 | 67 | @Override 68 | public Collection getAuthorities() { 69 | return singletonList(new SimpleGrantedAuthority(role.toString())); 70 | } 71 | 72 | @Override 73 | public boolean isAccountNonExpired() { 74 | return true; 75 | } 76 | 77 | @Override 78 | public boolean isAccountNonLocked() { 79 | return true; 80 | } 81 | 82 | @Override 83 | public boolean isCredentialsNonExpired() { 84 | return true; 85 | } 86 | 87 | @Override 88 | public boolean isEnabled() { 89 | return true; 90 | } 91 | 92 | public void setPassword(String password) { 93 | this.password = password; 94 | this.passwordUpdatedAt = new Date(); 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/filters/AuthenticationFilter.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.filters; 2 | 3 | import java.io.IOException; 4 | 5 | import javax.servlet.FilterChain; 6 | import javax.servlet.ServletException; 7 | import javax.servlet.http.HttpServletRequest; 8 | import javax.servlet.http.HttpServletResponse; 9 | 10 | import com.thegeekyasian.security.persistence.entities.User; 11 | import com.thegeekyasian.security.utils.AuthenticationUtils; 12 | import lombok.RequiredArgsConstructor; 13 | 14 | import org.springframework.security.core.context.SecurityContextHolder; 15 | import org.springframework.security.core.userdetails.UserDetailsService; 16 | import org.springframework.security.core.userdetails.UsernameNotFoundException; 17 | import org.springframework.stereotype.Component; 18 | import org.springframework.web.filter.OncePerRequestFilter; 19 | 20 | import static com.thegeekyasian.security.enums.TokenType.AUTH; 21 | import static com.thegeekyasian.security.utils.AuthenticationUtils.getAuthentication; 22 | import static com.thegeekyasian.security.utils.AuthenticationUtils.getSubjectFromToken; 23 | import static com.thegeekyasian.security.utils.AuthenticationUtils.isTokenIssuedAfterPasswordModified; 24 | import static com.thegeekyasian.security.utils.AuthenticationUtils.isTokenValid; 25 | import static org.springframework.util.StringUtils.hasText; 26 | 27 | /** 28 | * @author thegeekyasian.com 29 | *

30 | * Authentication filter 31 | *

32 | * The authentication filter intercepts all the HTTP Requests, 33 | * and validates a token for each request that encapsulates 34 | * the authentication token in the request header i.e. Authorization. 35 | *

36 | */ 37 | 38 | @Component 39 | @RequiredArgsConstructor 40 | public class AuthenticationFilter extends OncePerRequestFilter { 41 | 42 | private final UserDetailsService userDetailsService; 43 | 44 | @Override 45 | protected void doFilterInternal(HttpServletRequest request, 46 | HttpServletResponse response, FilterChain chain) 47 | throws ServletException, IOException { 48 | 49 | String token = AuthenticationUtils.getTokenFromRequest(request); 50 | if (hasText(token) && isTokenValid(token, AUTH)) { 51 | setSecurityContext(token); 52 | } 53 | 54 | chain.doFilter(request, response); 55 | } 56 | 57 | private void setSecurityContext(String token) { 58 | try { 59 | String username = getSubjectFromToken(token); 60 | User user = (User) userDetailsService.loadUserByUsername(username); 61 | 62 | if (isTokenIssuedAfterPasswordModified(token, user)) { 63 | SecurityContextHolder.getContext() 64 | .setAuthentication(getAuthentication(token, 65 | userDetailsService.loadUserByUsername(username))); 66 | } 67 | } 68 | catch (UsernameNotFoundException ignored) { 69 | } 70 | } 71 | } 72 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/controllers/AuthenticationController.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.controllers; 2 | 3 | import javax.validation.Valid; 4 | 5 | import com.thegeekyasian.security.controllers.resp.ResponseWrapper; 6 | import com.thegeekyasian.security.models.AuthenticationRequest; 7 | import com.thegeekyasian.security.models.RefreshTokenRequest; 8 | import com.thegeekyasian.security.models.RegistrationRequest; 9 | import com.thegeekyasian.security.services.IAuthenticationService; 10 | import com.thegeekyasian.security.services.IUserService; 11 | import lombok.RequiredArgsConstructor; 12 | 13 | import org.springframework.http.ResponseEntity; 14 | import org.springframework.web.bind.annotation.PostMapping; 15 | import org.springframework.web.bind.annotation.RequestBody; 16 | import org.springframework.web.bind.annotation.RequestMapping; 17 | import org.springframework.web.bind.annotation.RestController; 18 | 19 | /** 20 | * @author thegeekyasian.com 21 | */ 22 | @RestController 23 | @RequestMapping(value = "auth") 24 | @RequiredArgsConstructor 25 | public class AuthenticationController { 26 | 27 | private final IUserService userService; 28 | 29 | private final IAuthenticationService authenticationService; 30 | 31 | /** 32 | * Login user 33 | *

34 | * Logs in the user for the provided username and password. 35 | *

36 | * 37 | * @param authenticationRequest The AuthenticationReq holds a username and a password parameters. 38 | * @return The function returns ResponseEntity having the ResponseWrapper. The success response holds a JWT token. 39 | */ 40 | @PostMapping(value = "login") 41 | public ResponseEntity loginUser( 42 | @RequestBody @Valid AuthenticationRequest authenticationRequest) { 43 | return ResponseEntity.ok(ResponseWrapper 44 | .from(authenticationService.authenticateUser(authenticationRequest))); 45 | } 46 | 47 | /** 48 | * Register user 49 | *

50 | * Registers a new user for the provided username and password. 51 | * Registration succeeds only if no user with the provided username already exists. 52 | *

53 | * 54 | * @param registrationRequest The RegistrationReq holds a username, a password and a confirm-password parameters. 55 | * @return The function returns ResponseEntity having the ResponseWrapper. The success response holds a JWT token. 56 | */ 57 | @PostMapping(value = "register") 58 | public ResponseEntity registerUser( 59 | @RequestBody @Valid RegistrationRequest registrationRequest) { 60 | return ResponseEntity.ok(ResponseWrapper 61 | .from(userService.registerUser(registrationRequest))); 62 | } 63 | 64 | @PostMapping(value = "refresh") 65 | public ResponseEntity refreshToken( 66 | @RequestBody @Valid RefreshTokenRequest refreshTokenRequest) { 67 | return ResponseEntity.ok(ResponseWrapper 68 | .from(userService.refreshToken(refreshTokenRequest))); 69 | } 70 | } 71 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/validators/RegistrationReqValidator.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.validators; 2 | 3 | import java.util.concurrent.atomic.AtomicReference; 4 | 5 | import javax.validation.ConstraintValidator; 6 | import javax.validation.ConstraintValidatorContext; 7 | 8 | import com.thegeekyasian.security.models.RegistrationRequest; 9 | import com.thegeekyasian.security.persistence.repositories.UserRepository; 10 | import com.thegeekyasian.security.validators.annotations.ValidateRegistrationRequest; 11 | import lombok.RequiredArgsConstructor; 12 | import lombok.extern.slf4j.Slf4j; 13 | 14 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.UNMATCHED_PASSWORDS_ERROR; 15 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.USER_ALREADY_EXISTS; 16 | import static org.springframework.util.StringUtils.hasText; 17 | 18 | /** 19 | * RegistrationReqValidator 20 | *

21 | * Validates the RegistrationRequest before registering a user. 22 | * The validation has two parts: 23 | *

24 | *

25 | * 1. Validate if the provided password and confirm-password, both are equal. 26 | *

27 | *

28 | * 2. Validate that a user with similar username doesn't already exist. 29 | *

30 | * 31 | *

32 | * If any of the above conditions is false, the validation fails. 33 | *

34 | * 35 | * @author thegeekyasian.com 36 | */ 37 | @Slf4j 38 | @RequiredArgsConstructor 39 | public class RegistrationReqValidator 40 | implements ConstraintValidator { 41 | 42 | private final UserRepository userRepository; 43 | 44 | @Override 45 | public void initialize(ValidateRegistrationRequest validateRegistrationRequest) { 46 | } 47 | 48 | @Override 49 | public boolean isValid(RegistrationRequest registrationRequest, 50 | ConstraintValidatorContext constraintValidatorContext) { 51 | 52 | AtomicReference isValid = new AtomicReference<>(Boolean.TRUE); 53 | constraintValidatorContext.disableDefaultConstraintViolation(); 54 | 55 | // If the password and confirm-password do not match, return error. 56 | if (hasText(registrationRequest.getConfirmPassword()) 57 | && !registrationRequest.getConfirmPassword() 58 | .equals(registrationRequest.getPassword())) { 59 | isValid.set(Boolean.FALSE); 60 | constraintValidatorContext 61 | .buildConstraintViolationWithTemplate(UNMATCHED_PASSWORDS_ERROR) 62 | .addConstraintViolation(); 63 | } 64 | 65 | // If a user with similar username already exists, return error. 66 | userRepository.findByUsername(registrationRequest.getUsername()) 67 | .ifPresent(user -> { 68 | isValid.set(Boolean.FALSE); 69 | constraintValidatorContext 70 | .buildConstraintViolationWithTemplate(USER_ALREADY_EXISTS) 71 | .addConstraintViolation(); 72 | }); 73 | 74 | return isValid.get(); 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | org.springframework.boot 8 | spring-boot-starter-parent 9 | 2.5.4 10 | 11 | 12 | com.thegeekyasian 13 | spring-security-jwt-mysql 14 | 0.0.1-SNAPSHOT 15 | spring-security-jwt-mysql 16 | Demo project for Spring Boot 17 | 18 | 1.8 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-data-jpa 24 | 25 | 26 | org.springframework.boot 27 | spring-boot-starter-security 28 | 29 | 30 | org.springframework.boot 31 | spring-boot-starter-web 32 | 33 | 34 | 35 | mysql 36 | mysql-connector-java 37 | runtime 38 | 39 | 40 | org.projectlombok 41 | lombok 42 | true 43 | 44 | 45 | org.springframework.boot 46 | spring-boot-starter-test 47 | test 48 | 49 | 50 | org.springframework.security 51 | spring-security-test 52 | test 53 | 54 | 55 | org.springframework.boot 56 | spring-boot-starter-validation 57 | 2.4.0 58 | 59 | 60 | io.jsonwebtoken 61 | jjwt 62 | 0.9.1 63 | 64 | 65 | 66 | org.liquibase 67 | liquibase-core 68 | 4.4.3 69 | 70 | 71 | 72 | 73 | 74 | 75 | org.springframework.boot 76 | spring-boot-maven-plugin 77 | 78 | 79 | 80 | org.projectlombok 81 | lombok 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | -------------------------------------------------------------------------------- /src/test/java/com/thegeekyasian/security/services/AuthenticationServiceTest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.services; 2 | 3 | import javax.jws.soap.SOAPBinding.Use; 4 | 5 | import com.thegeekyasian.security.BaseServiceTest; 6 | import com.thegeekyasian.security.models.AuthResponse; 7 | import com.thegeekyasian.security.models.AuthenticationRequest; 8 | import com.thegeekyasian.security.persistence.entities.User; 9 | import org.junit.jupiter.api.Test; 10 | 11 | import org.springframework.beans.factory.annotation.Autowired; 12 | import org.springframework.boot.test.mock.mockito.MockBean; 13 | import org.springframework.context.annotation.Import; 14 | import org.springframework.security.authentication.AuthenticationManager; 15 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; 16 | 17 | import static com.thegeekyasian.security.utils.AuthenticationUtils.getSubjectFromToken; 18 | import static org.assertj.core.api.Assertions.assertThat; 19 | import static org.mockito.ArgumentMatchers.any; 20 | import static org.mockito.Mockito.mock; 21 | import static org.mockito.Mockito.times; 22 | import static org.mockito.Mockito.verify; 23 | import static org.mockito.Mockito.when; 24 | 25 | /** 26 | * @author thegeekyasian.com 27 | */ 28 | @Import({ AuthenticationService.class }) 29 | public class AuthenticationServiceTest extends BaseServiceTest { 30 | 31 | @Autowired 32 | private AuthenticationService authenticationService; 33 | 34 | @MockBean 35 | private AuthenticationManager authenticationManager; 36 | 37 | @Test 38 | public void shouldAuthenticateUserWithUsernameAndPassword() { 39 | 40 | when(authenticationManager.authenticate( 41 | any(UsernamePasswordAuthenticationToken.class))) 42 | .thenReturn(mock(UsernamePasswordAuthenticationToken.class)); 43 | 44 | Object authenticationObject = authenticationService 45 | .authenticateUser("test-user", "test-password"); 46 | 47 | assertThat(authenticationObject) 48 | .isInstanceOf(UsernamePasswordAuthenticationToken.class); 49 | verify(authenticationManager, times(1)) 50 | .authenticate(any(UsernamePasswordAuthenticationToken.class)); 51 | } 52 | 53 | @Test 54 | public void shouldAuthenticateUserWithAuthenticationRequest() { 55 | 56 | AuthenticationRequest authenticationRequest = AuthenticationRequest 57 | .from("test-username", "test-password"); 58 | UsernamePasswordAuthenticationToken authentication = 59 | mock(UsernamePasswordAuthenticationToken.class); 60 | 61 | when(authentication.getPrincipal()) 62 | .thenReturn(User.builder().username("test-username").build()); 63 | when(authenticationManager.authenticate( 64 | any(UsernamePasswordAuthenticationToken.class))) 65 | .thenReturn(authentication); 66 | 67 | AuthResponse authResponse = authenticationService 68 | .authenticateUser(authenticationRequest); 69 | 70 | assertThat(authResponse).isNotNull(); 71 | assertThat(authResponse.getType()).isEqualTo("Bearer"); 72 | assertThat(getSubjectFromToken(authResponse.getAuthToken())) 73 | .isEqualTo("test-username"); 74 | assertThat(getSubjectFromToken(authResponse.getRefreshToken())) 75 | .isEqualTo("test-username"); 76 | verify(authenticationManager, times(1)) 77 | .authenticate(any(UsernamePasswordAuthenticationToken.class)); 78 | } 79 | } 80 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/controllers/resp/CommonErrorHandler.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.controllers.resp; 2 | 3 | 4 | import java.util.stream.Collectors; 5 | 6 | import com.thegeekyasian.security.exceptions.UnauthorizedException; 7 | import io.jsonwebtoken.MalformedJwtException; 8 | import lombok.extern.slf4j.Slf4j; 9 | 10 | import org.springframework.context.support.DefaultMessageSourceResolvable; 11 | import org.springframework.http.HttpStatus; 12 | import org.springframework.security.authentication.BadCredentialsException; 13 | import org.springframework.security.core.userdetails.UsernameNotFoundException; 14 | import org.springframework.util.StringUtils; 15 | import org.springframework.web.bind.MethodArgumentNotValidException; 16 | import org.springframework.web.bind.MissingServletRequestParameterException; 17 | import org.springframework.web.bind.annotation.ExceptionHandler; 18 | import org.springframework.web.bind.annotation.ResponseStatus; 19 | import org.springframework.web.bind.annotation.RestControllerAdvice; 20 | 21 | import static org.springframework.http.HttpStatus.BAD_REQUEST; 22 | 23 | /** 24 | * @author thegeekyasian.com 25 | */ 26 | @RestControllerAdvice 27 | @Slf4j 28 | public class CommonErrorHandler { 29 | public static final String DEFAULT_BAD_REQUEST_ERROR = "Bad request to service"; 30 | 31 | public static final String DEFAULT_UNAUTHORIZED_ERROR = "You're not authorized to access this resource."; 32 | 33 | public static final String DEFAULT_BAD_CREDENTIALS_ERROR = "Invalid username or password"; 34 | 35 | public static final String USER_NOT_FOUND_ERROR = "No user found for the provided username."; 36 | 37 | public static final String UNMATCHED_PASSWORDS_ERROR = "Passwords do not match."; 38 | 39 | public static final String USER_ALREADY_EXISTS = "A user with this username already exists."; 40 | 41 | public static ErrorResponseWrapper generateError(int errorCode, Object message) { 42 | return ErrorResponseWrapper.builder() 43 | .result(String.valueOf(errorCode)) 44 | .message(message) 45 | .build(); 46 | } 47 | 48 | @ResponseStatus(BAD_REQUEST) 49 | @ExceptionHandler(MethodArgumentNotValidException.class) 50 | public ErrorResponseWrapper methodArgumentNotValidException( 51 | MethodArgumentNotValidException ex) { 52 | return generateError(BAD_REQUEST.value(), 53 | ex.getBindingResult() 54 | .getAllErrors() 55 | .stream() 56 | .map(DefaultMessageSourceResolvable::getDefaultMessage) 57 | .collect(Collectors.toList())); 58 | } 59 | 60 | @ExceptionHandler(UnauthorizedException.class) 61 | @ResponseStatus(HttpStatus.UNAUTHORIZED) 62 | ErrorResponseWrapper unauthorized(UnauthorizedException e) { 63 | return generateError(HttpStatus.UNAUTHORIZED.value(), 64 | StringUtils.hasText(e.getMessage()) ? 65 | DEFAULT_UNAUTHORIZED_ERROR : 66 | e.getMessage()); 67 | } 68 | 69 | @ExceptionHandler(MalformedJwtException.class) 70 | @ResponseStatus(HttpStatus.UNAUTHORIZED) 71 | ErrorResponseWrapper malformedJwtException() { 72 | return generateError(HttpStatus.UNAUTHORIZED.value(), 73 | "Invalid authentication token."); 74 | } 75 | 76 | @ExceptionHandler(MissingServletRequestParameterException.class) 77 | @ResponseStatus(HttpStatus.BAD_REQUEST) 78 | ErrorResponseWrapper missingRequestParams() { 79 | return generateError(HttpStatus.BAD_REQUEST.value(), 80 | DEFAULT_BAD_REQUEST_ERROR); 81 | } 82 | 83 | @ExceptionHandler(UsernameNotFoundException.class) 84 | @ResponseStatus(HttpStatus.NOT_FOUND) 85 | ErrorResponseWrapper notFound(UsernameNotFoundException e) { 86 | return generateError(HttpStatus.NOT_FOUND.value(), e.getMessage()); 87 | } 88 | 89 | @ExceptionHandler(BadCredentialsException.class) 90 | @ResponseStatus(HttpStatus.UNAUTHORIZED) 91 | ErrorResponseWrapper notFound(BadCredentialsException e) { 92 | return generateError(HttpStatus.UNAUTHORIZED.value(), 93 | DEFAULT_BAD_CREDENTIALS_ERROR); 94 | } 95 | } -------------------------------------------------------------------------------- /postman-collection.json: -------------------------------------------------------------------------------- 1 | { 2 | "info": { 3 | "_postman_id": "ad2697a2-92f4-4f85-8dd7-639c3524c22a", 4 | "name": "Spring Security by TheGeekyAsian", 5 | "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" 6 | }, 7 | "item": [ 8 | { 9 | "name": "Register user", 10 | "request": { 11 | "method": "POST", 12 | "header": [], 13 | "body": { 14 | "mode": "raw", 15 | "raw": "{\r\n \"username\" : \"thegeekyasian\",\r\n \"password\" : \"password\",\r\n \"confirm_password\" : \"password\"\r\n}", 16 | "options": { 17 | "raw": { 18 | "language": "json" 19 | } 20 | } 21 | }, 22 | "url": { 23 | "raw": "{{server-endpoint}}/auth/register", 24 | "host": [ 25 | "{{server-endpoint}}" 26 | ], 27 | "path": [ 28 | "auth", 29 | "register" 30 | ] 31 | } 32 | }, 33 | "response": [] 34 | }, 35 | { 36 | "name": "Login user", 37 | "request": { 38 | "method": "POST", 39 | "header": [], 40 | "body": { 41 | "mode": "raw", 42 | "raw": "{\r\n \"username\" : \"thegeekyasian\",\r\n \"password\" : \"password\"\r\n}", 43 | "options": { 44 | "raw": { 45 | "language": "json" 46 | } 47 | } 48 | }, 49 | "url": { 50 | "raw": "{{server-endpoint}}/auth/login", 51 | "host": [ 52 | "{{server-endpoint}}" 53 | ], 54 | "path": [ 55 | "auth", 56 | "login" 57 | ] 58 | } 59 | }, 60 | "response": [] 61 | }, 62 | { 63 | "name": "Change password", 64 | "request": { 65 | "method": "POST", 66 | "header": [ 67 | { 68 | "key": "Authorization", 69 | "value": "Bearer ", 70 | "type": "text" 71 | } 72 | ], 73 | "body": { 74 | "mode": "raw", 75 | "raw": "{\r\n \"password\" : \"password\",\r\n \"new_password\" : \"updated_password\",\r\n \"confirm_new_password\" : \"updated_password\"\r\n}", 76 | "options": { 77 | "raw": { 78 | "language": "json" 79 | } 80 | } 81 | }, 82 | "url": { 83 | "raw": "{{server-endpoint}}/users/change-password", 84 | "host": [ 85 | "{{server-endpoint}}" 86 | ], 87 | "path": [ 88 | "users", 89 | "change-password" 90 | ] 91 | } 92 | }, 93 | "response": [] 94 | }, 95 | { 96 | "name": "Refresh auth token", 97 | "request": { 98 | "method": "POST", 99 | "header": [ 100 | { 101 | "key": "Authorization", 102 | "type": "text", 103 | "value": "Bearer " 104 | } 105 | ], 106 | "body": { 107 | "mode": "raw", 108 | "raw": "{\r\n \"refresh_token\" : \"REFRESH_TOKEN_HERE\"\r\n}", 109 | "options": { 110 | "raw": { 111 | "language": "json" 112 | } 113 | } 114 | }, 115 | "url": { 116 | "raw": "{{server-endpoint}}/auth/refresh", 117 | "host": [ 118 | "{{server-endpoint}}" 119 | ], 120 | "path": [ 121 | "auth", 122 | "refresh" 123 | ] 124 | } 125 | }, 126 | "response": [] 127 | }, 128 | { 129 | "name": "Get current user with token", 130 | "request": { 131 | "method": "GET", 132 | "header": [ 133 | { 134 | "key": "Authorization", 135 | "type": "text", 136 | "value": "Bearer " 137 | } 138 | ], 139 | "url": { 140 | "raw": "{{server-endpoint}}/users/me", 141 | "host": [ 142 | "{{server-endpoint}}" 143 | ], 144 | "path": [ 145 | "users", 146 | "me" 147 | ] 148 | } 149 | }, 150 | "response": [] 151 | } 152 | ], 153 | "event": [ 154 | { 155 | "listen": "prerequest", 156 | "script": { 157 | "type": "text/javascript", 158 | "exec": [ 159 | "" 160 | ] 161 | } 162 | }, 163 | { 164 | "listen": "test", 165 | "script": { 166 | "type": "text/javascript", 167 | "exec": [ 168 | "" 169 | ] 170 | } 171 | } 172 | ], 173 | "variable": [ 174 | { 175 | "key": "server-endpoint", 176 | "value": "http://localhost:9000" 177 | } 178 | ] 179 | } -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/config/WebSecurityConfig.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.config; 2 | 3 | import com.thegeekyasian.security.SecurityAuthenticationEntryPoint; 4 | import com.thegeekyasian.security.filters.AuthenticationFilter; 5 | import lombok.RequiredArgsConstructor; 6 | 7 | import org.springframework.beans.factory.annotation.Autowired; 8 | import org.springframework.context.annotation.Bean; 9 | import org.springframework.context.annotation.Configuration; 10 | import org.springframework.security.access.hierarchicalroles.RoleHierarchy; 11 | import org.springframework.security.access.hierarchicalroles.RoleHierarchyImpl; 12 | import org.springframework.security.authentication.AuthenticationManager; 13 | import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder; 14 | import org.springframework.security.config.annotation.method.configuration.EnableGlobalMethodSecurity; 15 | import org.springframework.security.config.annotation.web.builders.HttpSecurity; 16 | import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; 17 | import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter; 18 | import org.springframework.security.config.http.SessionCreationPolicy; 19 | import org.springframework.security.core.userdetails.UserDetailsService; 20 | import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; 21 | import org.springframework.security.crypto.password.PasswordEncoder; 22 | import org.springframework.security.web.access.expression.DefaultWebSecurityExpressionHandler; 23 | import org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter; 24 | 25 | /** 26 | * @author thegeekyasian.com 27 | */ 28 | @EnableWebSecurity 29 | @Configuration 30 | @EnableGlobalMethodSecurity(prePostEnabled = true) 31 | @RequiredArgsConstructor 32 | public class WebSecurityConfig extends WebSecurityConfigurerAdapter { 33 | 34 | private final SecurityAuthenticationEntryPoint securityAuthenticationEntryPoint; 35 | 36 | private final UserDetailsService userDetailsService; 37 | 38 | private final AuthenticationFilter authenticationFilter; 39 | 40 | @Autowired 41 | public void configureGlobal(AuthenticationManagerBuilder authenticationManagerBuilder) throws Exception { 42 | authenticationManagerBuilder 43 | .userDetailsService(userDetailsService) 44 | .passwordEncoder(passwordEncoder()); 45 | } 46 | 47 | @Bean 48 | public PasswordEncoder passwordEncoder() { 49 | return new BCryptPasswordEncoder(); 50 | } 51 | 52 | @Bean 53 | @Override 54 | public AuthenticationManager authenticationManagerBean() throws Exception { 55 | return super.authenticationManagerBean(); 56 | } 57 | 58 | @Override 59 | protected void configure(HttpSecurity httpSecurity) throws Exception { 60 | 61 | httpSecurity.csrf() 62 | .disable() 63 | .authorizeRequests() 64 | 65 | .expressionHandler(getWebSecurityExpressionHandler()) 66 | // Permitting all the requests to the endpoint 'auth' as base. 67 | .antMatchers("/auth/**") 68 | .permitAll() 69 | .anyRequest() 70 | .authenticated() 71 | .and() 72 | 73 | // Providing a Security Authentication Entry Point to handle all authentication exceptions. 74 | .exceptionHandling() 75 | .authenticationEntryPoint(securityAuthenticationEntryPoint) 76 | .and() 77 | .sessionManagement() 78 | .sessionCreationPolicy(SessionCreationPolicy.STATELESS); 79 | 80 | // Add AuthenticationFilter to intercept each request that comes in. 81 | httpSecurity 82 | .addFilterBefore(authenticationFilter, 83 | UsernamePasswordAuthenticationFilter.class) 84 | .headers() 85 | .cacheControl() 86 | .disable(); 87 | httpSecurity.requestCache().disable(); 88 | 89 | } 90 | 91 | @Bean 92 | RoleHierarchy getRoleHierarchy() { 93 | RoleHierarchyImpl roleHierarchy = new RoleHierarchyImpl(); 94 | roleHierarchy.setHierarchy("ROLE_ADMIN > ROLE_USER"); 95 | return roleHierarchy; 96 | } 97 | 98 | @Bean 99 | DefaultWebSecurityExpressionHandler getWebSecurityExpressionHandler() { 100 | DefaultWebSecurityExpressionHandler handler = new DefaultWebSecurityExpressionHandler(); 101 | handler.setRoleHierarchy(getRoleHierarchy()); 102 | return handler; 103 | } 104 | } -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/services/UserService.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.services; 2 | 3 | import java.util.List; 4 | import java.util.Optional; 5 | 6 | import com.thegeekyasian.security.enums.TokenType; 7 | import com.thegeekyasian.security.exceptions.UnauthorizedException; 8 | import com.thegeekyasian.security.models.AuthResponse; 9 | import com.thegeekyasian.security.models.ChangePasswordRequest; 10 | import com.thegeekyasian.security.models.RefreshTokenRequest; 11 | import com.thegeekyasian.security.models.RegistrationRequest; 12 | import com.thegeekyasian.security.persistence.entities.User; 13 | import com.thegeekyasian.security.persistence.repositories.UserRepository; 14 | import lombok.RequiredArgsConstructor; 15 | 16 | import org.springframework.security.core.userdetails.UsernameNotFoundException; 17 | import org.springframework.stereotype.Service; 18 | 19 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.DEFAULT_UNAUTHORIZED_ERROR; 20 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.USER_NOT_FOUND_ERROR; 21 | import static com.thegeekyasian.security.enums.Role.ROLE_USER; 22 | import static com.thegeekyasian.security.utils.AuthenticationUtils.encodePassword; 23 | import static com.thegeekyasian.security.utils.AuthenticationUtils.generateAuthToken; 24 | import static com.thegeekyasian.security.utils.AuthenticationUtils.generateRefreshToken; 25 | import static com.thegeekyasian.security.utils.AuthenticationUtils.getCurrentUser; 26 | import static com.thegeekyasian.security.utils.AuthenticationUtils.getSubjectFromToken; 27 | import static com.thegeekyasian.security.utils.AuthenticationUtils.isTokenIssuedAfterPasswordModified; 28 | import static com.thegeekyasian.security.utils.AuthenticationUtils.isTokenValid; 29 | 30 | /** 31 | * @author thegeekyasian.com 32 | */ 33 | @Service 34 | @RequiredArgsConstructor 35 | public class UserService implements IUserService { 36 | 37 | private final UserRepository userRepository; 38 | 39 | private final IAuthenticationService authenticationService; 40 | 41 | @Override 42 | public AuthResponse registerUser(RegistrationRequest registrationRequest) { 43 | 44 | String encodedPassword = encodePassword(registrationRequest.getPassword()); 45 | 46 | User user = userRepository.save(User 47 | .builder() 48 | .username(registrationRequest.getUsername()) 49 | .password(encodedPassword) 50 | .role(ROLE_USER) 51 | .build()); 52 | 53 | return AuthResponse.from(generateAuthToken(user), 54 | generateRefreshToken(user)); 55 | } 56 | 57 | @Override 58 | public AuthResponse changePassword(ChangePasswordRequest changePasswordRequest) { 59 | 60 | String username = Optional.ofNullable(getCurrentUser()) 61 | .orElseThrow(() -> new UnauthorizedException(DEFAULT_UNAUTHORIZED_ERROR)) 62 | .getUsername(); 63 | 64 | authenticationService.authenticateUser(username, 65 | changePasswordRequest.getPassword()); 66 | 67 | String encodedPassword = encodePassword(changePasswordRequest.getNewPassword()); 68 | 69 | User user = userRepository.findByUsername(username) 70 | .orElseThrow(() -> new UsernameNotFoundException(USER_NOT_FOUND_ERROR)); 71 | user.setPassword(encodedPassword); 72 | user = userRepository.save(user); 73 | 74 | return AuthResponse.from(generateAuthToken(user), 75 | generateRefreshToken(user)); 76 | } 77 | 78 | @Override 79 | public AuthResponse refreshToken(RefreshTokenRequest refreshTokenRequest) { 80 | 81 | if (isTokenValid(refreshTokenRequest.getRefreshToken(), TokenType.REFRESH)) { 82 | String username = getSubjectFromToken(refreshTokenRequest.getRefreshToken()); 83 | User user = userRepository.getByUsername(username); 84 | 85 | if (isTokenIssuedAfterPasswordModified(refreshTokenRequest.getRefreshToken(), 86 | user)) { 87 | return AuthResponse.from(generateAuthToken(user), 88 | generateRefreshToken(user)); 89 | } 90 | } 91 | 92 | throw new UnauthorizedException(DEFAULT_UNAUTHORIZED_ERROR); 93 | } 94 | 95 | @Override 96 | public User getUser(String username) { 97 | return userRepository.findByUsername(username) 98 | .orElseThrow(() -> new UsernameNotFoundException(USER_NOT_FOUND_ERROR)); 99 | } 100 | 101 | @Override 102 | public List getAllUsers() { 103 | return userRepository.findAll(); 104 | } 105 | } 106 | -------------------------------------------------------------------------------- /.mvn/wrapper/MavenWrapperDownloader.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2007-present the original author or authors. 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * https://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | import java.net.*; 18 | import java.io.*; 19 | import java.nio.channels.*; 20 | import java.util.Properties; 21 | 22 | public class MavenWrapperDownloader { 23 | 24 | private static final String WRAPPER_VERSION = "0.5.6"; 25 | 26 | /** 27 | * Default URL to download the maven-wrapper.jar from, if no 'downloadUrl' is provided. 28 | */ 29 | private static final String DEFAULT_DOWNLOAD_URL = "https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/" 30 | + WRAPPER_VERSION + "/maven-wrapper-" + WRAPPER_VERSION + ".jar"; 31 | 32 | /** 33 | * Path to the maven-wrapper.properties file, which might contain a downloadUrl property to 34 | * use instead of the default one. 35 | */ 36 | private static final String MAVEN_WRAPPER_PROPERTIES_PATH = 37 | ".mvn/wrapper/maven-wrapper.properties"; 38 | 39 | /** 40 | * Path where the maven-wrapper.jar will be saved to. 41 | */ 42 | private static final String MAVEN_WRAPPER_JAR_PATH = 43 | ".mvn/wrapper/maven-wrapper.jar"; 44 | 45 | /** 46 | * Name of the property which should be used to override the default download url for the wrapper. 47 | */ 48 | private static final String PROPERTY_NAME_WRAPPER_URL = "wrapperUrl"; 49 | 50 | public static void main(String args[]) { 51 | System.out.println("- Downloader started"); 52 | File baseDirectory = new File(args[0]); 53 | System.out.println("- Using base directory: " + baseDirectory.getAbsolutePath()); 54 | 55 | // If the maven-wrapper.properties exists, read it and check if it contains a custom 56 | // wrapperUrl parameter. 57 | File mavenWrapperPropertyFile = new File(baseDirectory, MAVEN_WRAPPER_PROPERTIES_PATH); 58 | String url = DEFAULT_DOWNLOAD_URL; 59 | if (mavenWrapperPropertyFile.exists()) { 60 | FileInputStream mavenWrapperPropertyFileInputStream = null; 61 | try { 62 | mavenWrapperPropertyFileInputStream = new FileInputStream(mavenWrapperPropertyFile); 63 | Properties mavenWrapperProperties = new Properties(); 64 | mavenWrapperProperties.load(mavenWrapperPropertyFileInputStream); 65 | url = mavenWrapperProperties.getProperty(PROPERTY_NAME_WRAPPER_URL, url); 66 | } 67 | catch (IOException e) { 68 | System.out.println("- ERROR loading '" + MAVEN_WRAPPER_PROPERTIES_PATH + "'"); 69 | } 70 | finally { 71 | try { 72 | if (mavenWrapperPropertyFileInputStream != null) { 73 | mavenWrapperPropertyFileInputStream.close(); 74 | } 75 | } 76 | catch (IOException e) { 77 | // Ignore ... 78 | } 79 | } 80 | } 81 | System.out.println("- Downloading from: " + url); 82 | 83 | File outputFile = new File(baseDirectory.getAbsolutePath(), MAVEN_WRAPPER_JAR_PATH); 84 | if (!outputFile.getParentFile().exists()) { 85 | if (!outputFile.getParentFile().mkdirs()) { 86 | System.out.println( 87 | "- ERROR creating output directory '" + outputFile.getParentFile().getAbsolutePath() + "'"); 88 | } 89 | } 90 | System.out.println("- Downloading to: " + outputFile.getAbsolutePath()); 91 | try { 92 | downloadFileFromURL(url, outputFile); 93 | System.out.println("Done"); 94 | System.exit(0); 95 | } 96 | catch (Throwable e) { 97 | System.out.println("- Error downloading"); 98 | e.printStackTrace(); 99 | System.exit(1); 100 | } 101 | } 102 | 103 | private static void downloadFileFromURL(String urlString, File destination) throws Exception { 104 | if (System.getenv("MVNW_USERNAME") != null && System.getenv("MVNW_PASSWORD") != null) { 105 | String username = System.getenv("MVNW_USERNAME"); 106 | char[] password = System.getenv("MVNW_PASSWORD").toCharArray(); 107 | Authenticator.setDefault(new Authenticator() { 108 | @Override 109 | protected PasswordAuthentication getPasswordAuthentication() { 110 | return new PasswordAuthentication(username, password); 111 | } 112 | }); 113 | } 114 | URL website = new URL(urlString); 115 | ReadableByteChannel rbc; 116 | rbc = Channels.newChannel(website.openStream()); 117 | FileOutputStream fos = new FileOutputStream(destination); 118 | fos.getChannel().transferFrom(rbc, 0, Long.MAX_VALUE); 119 | fos.close(); 120 | rbc.close(); 121 | } 122 | 123 | } 124 | -------------------------------------------------------------------------------- /mvnw.cmd: -------------------------------------------------------------------------------- 1 | @REM ---------------------------------------------------------------------------- 2 | @REM Licensed to the Apache Software Foundation (ASF) under one 3 | @REM or more contributor license agreements. See the NOTICE file 4 | @REM distributed with this work for additional information 5 | @REM regarding copyright ownership. The ASF licenses this file 6 | @REM to you under the Apache License, Version 2.0 (the 7 | @REM "License"); you may not use this file except in compliance 8 | @REM with the License. You may obtain a copy of the License at 9 | @REM 10 | @REM https://www.apache.org/licenses/LICENSE-2.0 11 | @REM 12 | @REM Unless required by applicable law or agreed to in writing, 13 | @REM software distributed under the License is distributed on an 14 | @REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 15 | @REM KIND, either express or implied. See the License for the 16 | @REM specific language governing permissions and limitations 17 | @REM under the License. 18 | @REM ---------------------------------------------------------------------------- 19 | 20 | @REM ---------------------------------------------------------------------------- 21 | @REM Maven Start Up Batch script 22 | @REM 23 | @REM Required ENV vars: 24 | @REM JAVA_HOME - location of a JDK home dir 25 | @REM 26 | @REM Optional ENV vars 27 | @REM M2_HOME - location of maven2's installed home dir 28 | @REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 29 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 30 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | @REM e.g. to debug Maven itself, use 32 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | @REM ---------------------------------------------------------------------------- 35 | 36 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 37 | @echo off 38 | @REM set title of command window 39 | title %0 40 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 41 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 42 | 43 | @REM set %HOME% to equivalent of $HOME 44 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 45 | 46 | @REM Execute a user defined script before this one 47 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 48 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 49 | if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat" 50 | if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd" 51 | :skipRcPre 52 | 53 | @setlocal 54 | 55 | set ERROR_CODE=0 56 | 57 | @REM To isolate internal variables from possible post scripts, we use another setlocal 58 | @setlocal 59 | 60 | @REM ==== START VALIDATION ==== 61 | if not "%JAVA_HOME%" == "" goto OkJHome 62 | 63 | echo. 64 | echo Error: JAVA_HOME not found in your environment. >&2 65 | echo Please set the JAVA_HOME variable in your environment to match the >&2 66 | echo location of your Java installation. >&2 67 | echo. 68 | goto error 69 | 70 | :OkJHome 71 | if exist "%JAVA_HOME%\bin\java.exe" goto init 72 | 73 | echo. 74 | echo Error: JAVA_HOME is set to an invalid directory. >&2 75 | echo JAVA_HOME = "%JAVA_HOME%" >&2 76 | echo Please set the JAVA_HOME variable in your environment to match the >&2 77 | echo location of your Java installation. >&2 78 | echo. 79 | goto error 80 | 81 | @REM ==== END VALIDATION ==== 82 | 83 | :init 84 | 85 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 86 | @REM Fallback to current working directory if not found. 87 | 88 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 89 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 90 | 91 | set EXEC_DIR=%CD% 92 | set WDIR=%EXEC_DIR% 93 | :findBaseDir 94 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 95 | cd .. 96 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 97 | set WDIR=%CD% 98 | goto findBaseDir 99 | 100 | :baseDirFound 101 | set MAVEN_PROJECTBASEDIR=%WDIR% 102 | cd "%EXEC_DIR%" 103 | goto endDetectBaseDir 104 | 105 | :baseDirNotFound 106 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 107 | cd "%EXEC_DIR%" 108 | 109 | :endDetectBaseDir 110 | 111 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 112 | 113 | @setlocal EnableExtensions EnableDelayedExpansion 114 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 115 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 116 | 117 | :endReadAdditionalConfig 118 | 119 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 120 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 121 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 122 | 123 | set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" 124 | 125 | FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 126 | IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B 127 | ) 128 | 129 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 130 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 131 | if exist %WRAPPER_JAR% ( 132 | if "%MVNW_VERBOSE%" == "true" ( 133 | echo Found %WRAPPER_JAR% 134 | ) 135 | ) else ( 136 | if not "%MVNW_REPOURL%" == "" ( 137 | SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" 138 | ) 139 | if "%MVNW_VERBOSE%" == "true" ( 140 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 141 | echo Downloading from: %DOWNLOAD_URL% 142 | ) 143 | 144 | powershell -Command "&{"^ 145 | "$webclient = new-object System.Net.WebClient;"^ 146 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 147 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 148 | "}"^ 149 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^ 150 | "}" 151 | if "%MVNW_VERBOSE%" == "true" ( 152 | echo Finished downloading %WRAPPER_JAR% 153 | ) 154 | ) 155 | @REM End of extension 156 | 157 | @REM Provide a "standardized" way to retrieve the CLI args that will 158 | @REM work with both Windows and non-Windows executions. 159 | set MAVEN_CMD_LINE_ARGS=%* 160 | 161 | %MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 162 | if ERRORLEVEL 1 goto error 163 | goto end 164 | 165 | :error 166 | set ERROR_CODE=1 167 | 168 | :end 169 | @endlocal & set ERROR_CODE=%ERROR_CODE% 170 | 171 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost 172 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 173 | if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat" 174 | if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd" 175 | :skipRcPost 176 | 177 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 178 | if "%MAVEN_BATCH_PAUSE%" == "on" pause 179 | 180 | if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE% 181 | 182 | exit /B %ERROR_CODE% 183 | -------------------------------------------------------------------------------- /src/main/java/com/thegeekyasian/security/utils/AuthenticationUtils.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.utils; 2 | 3 | import java.util.Date; 4 | import java.util.HashMap; 5 | import java.util.Map; 6 | import java.util.Optional; 7 | 8 | import javax.servlet.http.HttpServletRequest; 9 | 10 | import com.thegeekyasian.security.enums.TokenType; 11 | import com.thegeekyasian.security.persistence.entities.User; 12 | import io.jsonwebtoken.Claims; 13 | import io.jsonwebtoken.JwtException; 14 | import io.jsonwebtoken.Jwts; 15 | import io.jsonwebtoken.SignatureAlgorithm; 16 | import lombok.extern.slf4j.Slf4j; 17 | 18 | import org.springframework.beans.factory.annotation.Autowired; 19 | import org.springframework.beans.factory.annotation.Value; 20 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; 21 | import org.springframework.security.core.Authentication; 22 | import org.springframework.security.core.context.SecurityContextHolder; 23 | import org.springframework.security.core.userdetails.UserDetails; 24 | import org.springframework.security.crypto.password.PasswordEncoder; 25 | import org.springframework.stereotype.Component; 26 | 27 | import static com.thegeekyasian.security.enums.TokenType.AUTH; 28 | import static com.thegeekyasian.security.enums.TokenType.REFRESH; 29 | import static java.util.Collections.singletonMap; 30 | import static java.util.Objects.isNull; 31 | 32 | /** 33 | * @author thegeekyasian.com 34 | */ 35 | @Slf4j 36 | @Component 37 | public class AuthenticationUtils { 38 | 39 | private static final String TOKEN_TYPE = "token_type"; 40 | 41 | private static String SECRET; 42 | 43 | private static PasswordEncoder PASSWORD_ENCODER; 44 | 45 | private static Long AUTH_TOKEN_EXPIRATION_SECONDS; 46 | 47 | private static Long REFRESH_TOKEN_EXPIRATION_SECONDS; 48 | 49 | @Autowired 50 | public AuthenticationUtils(PasswordEncoder passwordEncoder, 51 | @Value("${spring.security.jwt-secret}") 52 | String jwtSecret, 53 | @Value("${spring.security.jwt-expiration-in-seconds}") 54 | Long expirationInSeconds, 55 | @Value("${spring.security.jwt-refresh-token-expiration-in-seconds}") 56 | Long refreshTokenExpirationSeconds) { 57 | PASSWORD_ENCODER = passwordEncoder; 58 | SECRET = jwtSecret; 59 | AUTH_TOKEN_EXPIRATION_SECONDS = expirationInSeconds; 60 | REFRESH_TOKEN_EXPIRATION_SECONDS = refreshTokenExpirationSeconds; 61 | } 62 | 63 | /** 64 | * Get current user 65 | *

66 | * The method returns the current user by getting it 67 | * from the current context of the SecurityContextHolder. 68 | *

69 | * 70 | * @return User 71 | */ 72 | public static User getCurrentUser() { 73 | return Optional.ofNullable(SecurityContextHolder 74 | .getContext() 75 | .getAuthentication()) 76 | .map(authentication -> 77 | (User) authentication 78 | .getPrincipal()) 79 | .orElse(null); 80 | } 81 | 82 | /** 83 | * Get token from request 84 | *

85 | * Get auth token from HttpServletRequest. 86 | *

87 | * 88 | * @param httpServletRequest HttpServletRequest 89 | * @return String JWT auth token 90 | */ 91 | public static String getTokenFromRequest(HttpServletRequest httpServletRequest) { 92 | String requestTokenHeader = httpServletRequest.getHeader(SecurityConstants.HEADER_REQUEST_TOKEN_KEY); 93 | return requestTokenHeader != null && requestTokenHeader 94 | .startsWith(SecurityConstants.HEADER_REQUEST_TOKEN_VALUE_PREFIX) 95 | ? requestTokenHeader.substring(SecurityConstants.HEADER_REQUEST_TOKEN_VALUE_PREFIX.length()) 96 | : null; 97 | } 98 | 99 | public static String encodePassword(String password) { 100 | return PASSWORD_ENCODER.encode(password); 101 | } 102 | 103 | public static String getSubjectFromToken(String token) { 104 | return getAllClaimsFromToken(token).getSubject(); 105 | } 106 | 107 | public static Date getIssuedAtFromToken(String token) { 108 | return getAllClaimsFromToken(token).getIssuedAt(); 109 | } 110 | 111 | public static Claims getAllClaimsFromToken(String token) { 112 | return Jwts.parser() 113 | .setSigningKey(SECRET) 114 | .parseClaimsJws(token) 115 | .getBody(); 116 | } 117 | 118 | public static String generateAuthToken(UserDetails userDetails) { 119 | return generateToken(userDetails, AUTH_TOKEN_EXPIRATION_SECONDS, 120 | new HashMap<>(singletonMap(TOKEN_TYPE, AUTH))); 121 | } 122 | 123 | public static String generateRefreshToken(UserDetails userDetails) { 124 | return generateToken(userDetails, REFRESH_TOKEN_EXPIRATION_SECONDS, 125 | new HashMap<>(singletonMap(TOKEN_TYPE, REFRESH))); 126 | } 127 | 128 | public static String generateToken(UserDetails userDetails, Long expirationInSeconds, 129 | Map claims) { 130 | return generateToken(userDetails.getUsername(), expirationInSeconds, claims); 131 | } 132 | 133 | /** 134 | * Generate JWT token 135 | *

136 | * Generate a JWT token for the provided subject and claims. 137 | *

138 | * 139 | * @param subject username 140 | * @param claims token claims 141 | * @return JWT token 142 | */ 143 | public static String generateToken(String subject, Long expirationInSeconds, 144 | Map claims) { 145 | return Jwts.builder() 146 | .setClaims(Optional.ofNullable(claims) 147 | .orElse(new HashMap<>())) 148 | .setSubject(subject) 149 | .signWith(SignatureAlgorithm.HS512, SECRET) 150 | .setIssuedAt(new Date(System.currentTimeMillis())) 151 | .setExpiration(new Date(System.currentTimeMillis() 152 | + expirationInSeconds * 1000)) 153 | .compact(); 154 | 155 | } 156 | 157 | /** 158 | * Get authentication 159 | *

160 | * The method requires a JWT token as a parameter 161 | * and returns an Authentication object in response. 162 | *

163 | * 164 | * @param token String JWT auth token 165 | * @param userDetails Object of type UserDetails i.e. User 166 | * @return Authentication object 167 | */ 168 | 169 | public static Authentication getAuthentication(String token, 170 | UserDetails userDetails) { 171 | return new UsernamePasswordAuthenticationToken(userDetails, token, 172 | userDetails.getAuthorities()); 173 | } 174 | 175 | /** 176 | * Validate token. 177 | *

178 | * The method parses JWT auth token by getting all the claims from it. 179 | * If the parse is successful, the function returns true, and false otherwise. 180 | *

181 | * 182 | * @param token A String JWT token. 183 | * @return boolean 184 | */ 185 | public static Boolean isTokenValid(String token, TokenType tokenType) { 186 | try { 187 | Claims claims = getAllClaimsFromToken(token); 188 | return claims.get(TOKEN_TYPE).equals(tokenType.toString()) 189 | && claims.getExpiration().after(new Date()); 190 | } 191 | catch (IllegalArgumentException | JwtException e) { 192 | log.error("Invalid JWT auth token", e); 193 | } 194 | return Boolean.FALSE; 195 | } 196 | 197 | public static Boolean isTokenIssuedAfterPasswordModified(String token, User user) { 198 | return isNull(user.getPasswordUpdatedAt()) 199 | || user.getPasswordUpdatedAt().getTime() 200 | <= getIssuedAtFromToken(token).getTime(); 201 | } 202 | 203 | public static class SecurityConstants { 204 | public static final String HEADER_REQUEST_TOKEN_KEY = "Authorization"; 205 | 206 | public static final String HEADER_REQUEST_TOKEN_VALUE_PREFIX = "Bearer "; 207 | } 208 | } -------------------------------------------------------------------------------- /src/test/java/com/thegeekyasian/security/services/UserServiceTest.java: -------------------------------------------------------------------------------- 1 | package com.thegeekyasian.security.services; 2 | 3 | import java.util.Optional; 4 | 5 | import com.thegeekyasian.security.BaseServiceTest; 6 | import com.thegeekyasian.security.exceptions.UnauthorizedException; 7 | import com.thegeekyasian.security.models.AuthResponse; 8 | import com.thegeekyasian.security.models.ChangePasswordRequest; 9 | import com.thegeekyasian.security.models.RefreshTokenRequest; 10 | import com.thegeekyasian.security.models.RegistrationRequest; 11 | import com.thegeekyasian.security.persistence.entities.User; 12 | import com.thegeekyasian.security.persistence.repositories.UserRepository; 13 | import org.junit.jupiter.api.Test; 14 | 15 | import org.springframework.beans.factory.annotation.Autowired; 16 | import org.springframework.boot.test.mock.mockito.MockBean; 17 | import org.springframework.context.annotation.Import; 18 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; 19 | import org.springframework.security.core.context.SecurityContext; 20 | import org.springframework.security.core.context.SecurityContextHolder; 21 | import org.springframework.security.core.context.SecurityContextImpl; 22 | import org.springframework.security.core.userdetails.UsernameNotFoundException; 23 | 24 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.DEFAULT_UNAUTHORIZED_ERROR; 25 | import static com.thegeekyasian.security.controllers.resp.CommonErrorHandler.USER_NOT_FOUND_ERROR; 26 | import static com.thegeekyasian.security.utils.AuthenticationUtils.generateAuthToken; 27 | import static com.thegeekyasian.security.utils.AuthenticationUtils.generateRefreshToken; 28 | import static com.thegeekyasian.security.utils.AuthenticationUtils.getSubjectFromToken; 29 | import static org.assertj.core.api.Assertions.assertThat; 30 | import static org.assertj.core.api.Assertions.catchThrowableOfType; 31 | import static org.mockito.ArgumentMatchers.any; 32 | import static org.mockito.ArgumentMatchers.anyString; 33 | import static org.mockito.Mockito.mock; 34 | import static org.mockito.Mockito.times; 35 | import static org.mockito.Mockito.verify; 36 | import static org.mockito.Mockito.when; 37 | 38 | /** 39 | * @author thegeekyasian.com 40 | */ 41 | @Import({ UserService.class }) 42 | public class UserServiceTest extends BaseServiceTest { 43 | 44 | @Autowired 45 | private UserService userService; 46 | 47 | @MockBean 48 | private UserRepository userRepository; 49 | 50 | @MockBean 51 | private AuthenticationService authenticationService; 52 | 53 | @Test 54 | public void shouldRegisterUser() { 55 | 56 | RegistrationRequest registrationRequest = RegistrationRequest.builder() 57 | .username("test-username") 58 | .password("test-password") 59 | .confirmPassword("test-password") 60 | .build(); 61 | 62 | when(userRepository.save(any(User.class))) 63 | .thenReturn(User.builder().username("test-username").build()); 64 | 65 | AuthResponse authResponse = userService.registerUser(registrationRequest); 66 | 67 | assertThat(authResponse).isNotNull(); 68 | assertThat(authResponse.getType()).isEqualTo("Bearer"); 69 | assertThat(getSubjectFromToken(authResponse.getAuthToken())) 70 | .isEqualTo("test-username"); 71 | assertThat(getSubjectFromToken(authResponse.getRefreshToken())) 72 | .isEqualTo("test-username"); 73 | verify(userRepository, times(1)) 74 | .save(any(User.class)); 75 | } 76 | 77 | @Test 78 | public void shouldChangePassword() { 79 | 80 | final String username = "test-username"; 81 | final ChangePasswordRequest changePasswordRequest = ChangePasswordRequest.builder() 82 | .password("test-password") 83 | .newPassword("new-test-password") 84 | .confirmNewPassword("new-test-password") 85 | .build(); 86 | final User user = mock(User.class); 87 | 88 | UsernamePasswordAuthenticationToken authentication = 89 | mock(UsernamePasswordAuthenticationToken.class); 90 | 91 | when(user.getUsername()).thenReturn(username); 92 | when(authentication.getPrincipal()) 93 | .thenReturn(User.builder().username(username).build()); 94 | SecurityContext securityContext = new SecurityContextImpl(); 95 | securityContext.setAuthentication(authentication); 96 | SecurityContextHolder.setContext(securityContext); 97 | 98 | when(userRepository.findByUsername(username)) 99 | .thenReturn(Optional.of(user)); 100 | when(userRepository.save(user)) 101 | .thenReturn(user); 102 | 103 | AuthResponse authResponse = userService.changePassword(changePasswordRequest); 104 | 105 | assertThat(authResponse).isNotNull(); 106 | assertThat(authResponse.getType()).isEqualTo("Bearer"); 107 | assertThat(getSubjectFromToken(authResponse.getAuthToken())) 108 | .isEqualTo(username); 109 | assertThat(getSubjectFromToken(authResponse.getRefreshToken())) 110 | .isEqualTo(username); 111 | verify(user, times(1)).setPassword(anyString()); 112 | verify(userRepository, times(1)).findByUsername(username); 113 | verify(userRepository, times(1)).save(user); 114 | } 115 | 116 | @Test 117 | public void shouldThrowException_WhenChangePasswordAndSecurityContextIsNull() { 118 | 119 | final ChangePasswordRequest changePasswordRequest = ChangePasswordRequest.builder() 120 | .password("test-password") 121 | .newPassword("new-test-password") 122 | .confirmNewPassword("new-test-password") 123 | .build(); 124 | 125 | SecurityContext securityContext = new SecurityContextImpl(); 126 | securityContext.setAuthentication(null); 127 | SecurityContextHolder.setContext(securityContext); 128 | 129 | UnauthorizedException unauthorizedException = catchThrowableOfType(() -> 130 | userService.changePassword(changePasswordRequest), 131 | UnauthorizedException.class); 132 | 133 | assertThat(unauthorizedException).isNotNull(); 134 | assertThat(unauthorizedException.getMessage()) 135 | .isEqualTo(DEFAULT_UNAUTHORIZED_ERROR); 136 | verify(userRepository, times(0)).save(any(User.class)); 137 | } 138 | 139 | @Test 140 | public void shouldRefreshToken() { 141 | 142 | final User user = User.builder().username("test-username").build(); 143 | final String refreshToken = generateRefreshToken(user); 144 | final RefreshTokenRequest refreshTokenRequest = RefreshTokenRequest.builder() 145 | .refreshToken(refreshToken).build(); 146 | 147 | when(userRepository.getByUsername(user.getUsername())) 148 | .thenReturn(user); 149 | 150 | AuthResponse authResponse = userService.refreshToken(refreshTokenRequest); 151 | 152 | assertThat(authResponse).isNotNull(); 153 | assertThat(authResponse.getType()).isEqualTo("Bearer"); 154 | assertThat(getSubjectFromToken(authResponse.getAuthToken())) 155 | .isEqualTo(user.getUsername()); 156 | assertThat(getSubjectFromToken(authResponse.getRefreshToken())) 157 | .isEqualTo(user.getUsername()); 158 | verify(userRepository, times(1)) 159 | .getByUsername(user.getUsername()); 160 | } 161 | 162 | @Test 163 | public void shouldThrowException_WhenRefreshTokenWithAuthToken() { 164 | 165 | final User user = User.builder().username("test-username").build(); 166 | final String refreshToken = generateAuthToken(user); 167 | final RefreshTokenRequest refreshTokenRequest = RefreshTokenRequest.builder() 168 | .refreshToken(refreshToken).build(); 169 | 170 | when(userRepository.getByUsername(user.getUsername())) 171 | .thenReturn(user); 172 | 173 | UnauthorizedException unauthorizedException = catchThrowableOfType(() 174 | -> userService.refreshToken(refreshTokenRequest), 175 | UnauthorizedException.class); 176 | 177 | assertThat(unauthorizedException).isNotNull(); 178 | assertThat(unauthorizedException.getMessage()) 179 | .isEqualTo(DEFAULT_UNAUTHORIZED_ERROR); 180 | verify(userRepository, times(0)) 181 | .getByUsername(user.getUsername()); 182 | } 183 | 184 | @Test 185 | public void shouldGFindUserByUsername() { 186 | 187 | final User user = User.builder().username("test-username").build(); 188 | 189 | when(userRepository.findByUsername(user.getUsername())) 190 | .thenReturn(Optional.of(user)); 191 | 192 | User u = userService.getUser(user.getUsername()); 193 | 194 | assertThat(u).isNotNull(); 195 | assertThat(user.getUsername()).isEqualTo(user.getUsername()); 196 | verify(userRepository, times(1)) 197 | .findByUsername(user.getUsername()); 198 | } 199 | 200 | @Test 201 | public void shouldThrowExceptionWhenFindUserByUsername() { 202 | 203 | final User user = User.builder().username("test-username").build(); 204 | 205 | when(userRepository.findByUsername(user.getUsername())) 206 | .thenReturn(Optional.empty()); 207 | 208 | UsernameNotFoundException usernameNotFoundException = catchThrowableOfType(() -> 209 | userService.getUser(user.getUsername()), 210 | UsernameNotFoundException.class); 211 | 212 | assertThat(usernameNotFoundException).isNotNull(); 213 | assertThat(usernameNotFoundException.getMessage()) 214 | .isEqualTo(USER_NOT_FOUND_ERROR); 215 | verify(userRepository, times(1)) 216 | .findByUsername(user.getUsername()); 217 | } 218 | } 219 | -------------------------------------------------------------------------------- /mvnw: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # ---------------------------------------------------------------------------- 3 | # Licensed to the Apache Software Foundation (ASF) under one 4 | # or more contributor license agreements. See the NOTICE file 5 | # distributed with this work for additional information 6 | # regarding copyright ownership. The ASF licenses this file 7 | # to you under the Apache License, Version 2.0 (the 8 | # "License"); you may not use this file except in compliance 9 | # with the License. You may obtain a copy of the License at 10 | # 11 | # https://www.apache.org/licenses/LICENSE-2.0 12 | # 13 | # Unless required by applicable law or agreed to in writing, 14 | # software distributed under the License is distributed on an 15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 | # KIND, either express or implied. See the License for the 17 | # specific language governing permissions and limitations 18 | # under the License. 19 | # ---------------------------------------------------------------------------- 20 | 21 | # ---------------------------------------------------------------------------- 22 | # Maven Start Up Batch script 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # M2_HOME - location of maven2's installed home dir 31 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 32 | # e.g. to debug Maven itself, use 33 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 34 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 35 | # ---------------------------------------------------------------------------- 36 | 37 | if [ -z "$MAVEN_SKIP_RC" ]; then 38 | 39 | if [ -f /etc/mavenrc ]; then 40 | . /etc/mavenrc 41 | fi 42 | 43 | if [ -f "$HOME/.mavenrc" ]; then 44 | . "$HOME/.mavenrc" 45 | fi 46 | 47 | fi 48 | 49 | # OS specific support. $var _must_ be set to either true or false. 50 | cygwin=false 51 | darwin=false 52 | mingw=false 53 | case "$(uname)" in 54 | CYGWIN*) cygwin=true ;; 55 | MINGW*) mingw=true ;; 56 | Darwin*) 57 | darwin=true 58 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 59 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 60 | if [ -z "$JAVA_HOME" ]; then 61 | if [ -x "/usr/libexec/java_home" ]; then 62 | export JAVA_HOME="$(/usr/libexec/java_home)" 63 | else 64 | export JAVA_HOME="/Library/Java/Home" 65 | fi 66 | fi 67 | ;; 68 | esac 69 | 70 | if [ -z "$JAVA_HOME" ]; then 71 | if [ -r /etc/gentoo-release ]; then 72 | JAVA_HOME=$(java-config --jre-home) 73 | fi 74 | fi 75 | 76 | if [ -z "$M2_HOME" ]; then 77 | ## resolve links - $0 may be a link to maven's home 78 | PRG="$0" 79 | 80 | # need this for relative symlinks 81 | while [ -h "$PRG" ]; do 82 | ls=$(ls -ld "$PRG") 83 | link=$(expr "$ls" : '.*-> \(.*\)$') 84 | if expr "$link" : '/.*' >/dev/null; then 85 | PRG="$link" 86 | else 87 | PRG="$(dirname "$PRG")/$link" 88 | fi 89 | done 90 | 91 | saveddir=$(pwd) 92 | 93 | M2_HOME=$(dirname "$PRG")/.. 94 | 95 | # make it fully qualified 96 | M2_HOME=$(cd "$M2_HOME" && pwd) 97 | 98 | cd "$saveddir" 99 | # echo Using m2 at $M2_HOME 100 | fi 101 | 102 | # For Cygwin, ensure paths are in UNIX format before anything is touched 103 | if $cygwin; then 104 | [ -n "$M2_HOME" ] && 105 | M2_HOME=$(cygpath --unix "$M2_HOME") 106 | [ -n "$JAVA_HOME" ] && 107 | JAVA_HOME=$(cygpath --unix "$JAVA_HOME") 108 | [ -n "$CLASSPATH" ] && 109 | CLASSPATH=$(cygpath --path --unix "$CLASSPATH") 110 | fi 111 | 112 | # For Mingw, ensure paths are in UNIX format before anything is touched 113 | if $mingw; then 114 | [ -n "$M2_HOME" ] && 115 | M2_HOME="$( ( 116 | cd "$M2_HOME" 117 | pwd 118 | ))" 119 | [ -n "$JAVA_HOME" ] && 120 | JAVA_HOME="$( ( 121 | cd "$JAVA_HOME" 122 | pwd 123 | ))" 124 | fi 125 | 126 | if [ -z "$JAVA_HOME" ]; then 127 | javaExecutable="$(which javac)" 128 | if [ -n "$javaExecutable" ] && ! [ "$(expr \"$javaExecutable\" : '\([^ ]*\)')" = "no" ]; then 129 | # readlink(1) is not available as standard on Solaris 10. 130 | readLink=$(which readlink) 131 | if [ ! $(expr "$readLink" : '\([^ ]*\)') = "no" ]; then 132 | if $darwin; then 133 | javaHome="$(dirname \"$javaExecutable\")" 134 | javaExecutable="$(cd \"$javaHome\" && pwd -P)/javac" 135 | else 136 | javaExecutable="$(readlink -f \"$javaExecutable\")" 137 | fi 138 | javaHome="$(dirname \"$javaExecutable\")" 139 | javaHome=$(expr "$javaHome" : '\(.*\)/bin') 140 | JAVA_HOME="$javaHome" 141 | export JAVA_HOME 142 | fi 143 | fi 144 | fi 145 | 146 | if [ -z "$JAVACMD" ]; then 147 | if [ -n "$JAVA_HOME" ]; then 148 | if [ -x "$JAVA_HOME/jre/sh/java" ]; then 149 | # IBM's JDK on AIX uses strange locations for the executables 150 | JAVACMD="$JAVA_HOME/jre/sh/java" 151 | else 152 | JAVACMD="$JAVA_HOME/bin/java" 153 | fi 154 | else 155 | JAVACMD="$(which java)" 156 | fi 157 | fi 158 | 159 | if [ ! -x "$JAVACMD" ]; then 160 | echo "Error: JAVA_HOME is not defined correctly." >&2 161 | echo " We cannot execute $JAVACMD" >&2 162 | exit 1 163 | fi 164 | 165 | if [ -z "$JAVA_HOME" ]; then 166 | echo "Warning: JAVA_HOME environment variable is not set." 167 | fi 168 | 169 | CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher 170 | 171 | # traverses directory structure from process work directory to filesystem root 172 | # first directory with .mvn subdirectory is considered project base directory 173 | find_maven_basedir() { 174 | 175 | if [ -z "$1" ]; then 176 | echo "Path not specified to find_maven_basedir" 177 | return 1 178 | fi 179 | 180 | basedir="$1" 181 | wdir="$1" 182 | while [ "$wdir" != '/' ]; do 183 | if [ -d "$wdir"/.mvn ]; then 184 | basedir=$wdir 185 | break 186 | fi 187 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 188 | if [ -d "${wdir}" ]; then 189 | wdir=$( 190 | cd "$wdir/.." 191 | pwd 192 | ) 193 | fi 194 | # end of workaround 195 | done 196 | echo "${basedir}" 197 | } 198 | 199 | # concatenates all lines of a file 200 | concat_lines() { 201 | if [ -f "$1" ]; then 202 | echo "$(tr -s '\n' ' ' <"$1")" 203 | fi 204 | } 205 | 206 | BASE_DIR=$(find_maven_basedir "$(pwd)") 207 | if [ -z "$BASE_DIR" ]; then 208 | exit 1 209 | fi 210 | 211 | ########################################################################################## 212 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 213 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 214 | ########################################################################################## 215 | if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then 216 | if [ "$MVNW_VERBOSE" = true ]; then 217 | echo "Found .mvn/wrapper/maven-wrapper.jar" 218 | fi 219 | else 220 | if [ "$MVNW_VERBOSE" = true ]; then 221 | echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..." 222 | fi 223 | if [ -n "$MVNW_REPOURL" ]; then 224 | jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" 225 | else 226 | jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar" 227 | fi 228 | while IFS="=" read key value; do 229 | case "$key" in wrapperUrl) 230 | jarUrl="$value" 231 | break 232 | ;; 233 | esac 234 | done <"$BASE_DIR/.mvn/wrapper/maven-wrapper.properties" 235 | if [ "$MVNW_VERBOSE" = true ]; then 236 | echo "Downloading from: $jarUrl" 237 | fi 238 | wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" 239 | if $cygwin; then 240 | wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") 241 | fi 242 | 243 | if command -v wget >/dev/null; then 244 | if [ "$MVNW_VERBOSE" = true ]; then 245 | echo "Found wget ... using wget" 246 | fi 247 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 248 | wget "$jarUrl" -O "$wrapperJarPath" 249 | else 250 | wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath" 251 | fi 252 | elif command -v curl >/dev/null; then 253 | if [ "$MVNW_VERBOSE" = true ]; then 254 | echo "Found curl ... using curl" 255 | fi 256 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 257 | curl -o "$wrapperJarPath" "$jarUrl" -f 258 | else 259 | curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f 260 | fi 261 | 262 | else 263 | if [ "$MVNW_VERBOSE" = true ]; then 264 | echo "Falling back to using Java to download" 265 | fi 266 | javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java" 267 | # For Cygwin, switch paths to Windows format before running javac 268 | if $cygwin; then 269 | javaClass=$(cygpath --path --windows "$javaClass") 270 | fi 271 | if [ -e "$javaClass" ]; then 272 | if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 273 | if [ "$MVNW_VERBOSE" = true ]; then 274 | echo " - Compiling MavenWrapperDownloader.java ..." 275 | fi 276 | # Compiling the Java class 277 | ("$JAVA_HOME/bin/javac" "$javaClass") 278 | fi 279 | if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then 280 | # Running the downloader 281 | if [ "$MVNW_VERBOSE" = true ]; then 282 | echo " - Running MavenWrapperDownloader.java ..." 283 | fi 284 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR") 285 | fi 286 | fi 287 | fi 288 | fi 289 | ########################################################################################## 290 | # End of extension 291 | ########################################################################################## 292 | 293 | export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"} 294 | if [ "$MVNW_VERBOSE" = true ]; then 295 | echo $MAVEN_PROJECTBASEDIR 296 | fi 297 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 298 | 299 | # For Cygwin, switch paths to Windows format before running java 300 | if $cygwin; then 301 | [ -n "$M2_HOME" ] && 302 | M2_HOME=$(cygpath --path --windows "$M2_HOME") 303 | [ -n "$JAVA_HOME" ] && 304 | JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") 305 | [ -n "$CLASSPATH" ] && 306 | CLASSPATH=$(cygpath --path --windows "$CLASSPATH") 307 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 308 | MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") 309 | fi 310 | 311 | # Provide a "standardized" way to retrieve the CLI args that will 312 | # work with both Windows and non-Windows executions. 313 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@" 314 | export MAVEN_CMD_LINE_ARGS 315 | 316 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 317 | 318 | exec "$JAVACMD" \ 319 | $MAVEN_OPTS \ 320 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 321 | "-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 322 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 323 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------