├── .mvn └── wrapper │ ├── maven-wrapper.jar │ └── maven-wrapper.properties ├── src ├── main │ ├── java │ │ └── com │ │ │ └── example │ │ │ ├── twofactorauth │ │ │ ├── TwoFactorAuthenticationCodeVerifier.java │ │ │ ├── TwoFactorAuthorizationManager.java │ │ │ ├── totp │ │ │ │ ├── TotpAuthenticationCodeVerifier.java │ │ │ │ └── QrCode.java │ │ │ ├── TwoFactorAuthentication.java │ │ │ ├── TwoFactorAuthenticationSuccessHandler.java │ │ │ └── web │ │ │ │ └── TwoFactorAuthController.java │ │ │ ├── DemoTwoFactorAuthenticationApplication.java │ │ │ ├── account │ │ │ ├── web │ │ │ │ ├── WelcomeController.java │ │ │ │ └── SignupController.java │ │ │ ├── Account.java │ │ │ ├── AccountUserDetailsService.java │ │ │ ├── AccountService.java │ │ │ └── AccountUserDetails.java │ │ │ └── SecurityConfig.java │ └── resources │ │ ├── schema.sql │ │ ├── application.properties │ │ └── templates │ │ ├── index.mustache │ │ ├── totp.mustache │ │ ├── signup.mustache │ │ └── enable-2fa.mustache └── test │ └── java │ └── com │ └── example │ └── DemoTwoFactorAuthenticationApplicationTests.java ├── docker-compose.yml ├── .gitignore ├── README.md ├── pom.xml ├── mvnw.cmd └── mvnw /.mvn/wrapper/maven-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/making/demo-two-factor-authentication/HEAD/.mvn/wrapper/maven-wrapper.jar -------------------------------------------------------------------------------- /.mvn/wrapper/maven-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.4/apache-maven-3.9.4-bin.zip 2 | wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar 3 | -------------------------------------------------------------------------------- /src/main/java/com/example/twofactorauth/TwoFactorAuthenticationCodeVerifier.java: -------------------------------------------------------------------------------- 1 | package com.example.twofactorauth; 2 | 3 | import com.example.account.Account; 4 | 5 | public interface TwoFactorAuthenticationCodeVerifier { 6 | 7 | boolean verify(Account account, String code); 8 | 9 | } 10 | -------------------------------------------------------------------------------- /src/main/resources/schema.sql: -------------------------------------------------------------------------------- 1 | CREATE TABLE IF NOT EXISTS account 2 | ( 3 | username VARCHAR(128) NOT NULL, 4 | password VARCHAR(256) NOT NULL, 5 | two_factor_secret VARCHAR(256) NOT NULL, 6 | two_factor_enabled boolean NOT NULL DEFAULT false, 7 | PRIMARY KEY (username) 8 | ); -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "2" 2 | services: 3 | postgresql: 4 | image: bitnami/postgresql:15 5 | labels: 6 | org.springframework.boot.service-connection: postgres 7 | ports: 8 | - 5432:5432 9 | environment: 10 | POSTGRES_DB: demo 11 | POSTGRES_USER: demo 12 | POSTGRES_PASSWORD: demo -------------------------------------------------------------------------------- /src/test/java/com/example/DemoTwoFactorAuthenticationApplicationTests.java: -------------------------------------------------------------------------------- 1 | package com.example; 2 | 3 | import org.junit.jupiter.api.Test; 4 | 5 | import org.springframework.boot.test.context.SpringBootTest; 6 | 7 | @SpringBootTest 8 | class DemoTwoFactorAuthenticationApplicationTests { 9 | 10 | @Test 11 | void contextLoads() { 12 | } 13 | 14 | } 15 | -------------------------------------------------------------------------------- /src/main/resources/application.properties: -------------------------------------------------------------------------------- 1 | logging.level.sql=debug 2 | spring.datasource.driver-class-name=org.postgresql.Driver 3 | spring.datasource.password=demo 4 | spring.datasource.url=jdbc:postgresql://localhost:5432/demo 5 | spring.datasource.username=demo 6 | spring.docker.compose.lifecycle-management=start_only 7 | spring.mustache.servlet.expose-request-attributes=true 8 | #spring.session.jdbc.initialize-schema=always 9 | spring.sql.init.mode=always -------------------------------------------------------------------------------- /src/main/java/com/example/DemoTwoFactorAuthenticationApplication.java: -------------------------------------------------------------------------------- 1 | package com.example; 2 | 3 | import org.springframework.boot.SpringApplication; 4 | import org.springframework.boot.autoconfigure.SpringBootApplication; 5 | 6 | @SpringBootApplication 7 | public class DemoTwoFactorAuthenticationApplication { 8 | 9 | public static void main(String[] args) { 10 | SpringApplication.run(DemoTwoFactorAuthenticationApplication.class, args); 11 | } 12 | 13 | } 14 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | HELP.md 2 | target/ 3 | !.mvn/wrapper/maven-wrapper.jar 4 | !**/src/main/**/target/ 5 | !**/src/test/**/target/ 6 | 7 | ### STS ### 8 | .apt_generated 9 | .classpath 10 | .factorypath 11 | .project 12 | .settings 13 | .springBeans 14 | .sts4-cache 15 | 16 | ### IntelliJ IDEA ### 17 | .idea 18 | *.iws 19 | *.iml 20 | *.ipr 21 | 22 | ### NetBeans ### 23 | /nbproject/private/ 24 | /nbbuild/ 25 | /dist/ 26 | /nbdist/ 27 | /.nb-gradle/ 28 | build/ 29 | !**/src/main/**/build/ 30 | !**/src/test/**/build/ 31 | 32 | ### VS Code ### 33 | .vscode/ 34 | -------------------------------------------------------------------------------- /src/main/java/com/example/account/web/WelcomeController.java: -------------------------------------------------------------------------------- 1 | package com.example.account.web; 2 | 3 | import com.example.account.AccountUserDetails; 4 | 5 | import org.springframework.security.core.annotation.AuthenticationPrincipal; 6 | import org.springframework.stereotype.Controller; 7 | import org.springframework.ui.Model; 8 | import org.springframework.web.bind.annotation.GetMapping; 9 | 10 | @Controller 11 | public class WelcomeController { 12 | 13 | @GetMapping(path = "/") 14 | public String index(@AuthenticationPrincipal AccountUserDetails accountUserDetails, Model model) { 15 | model.addAttribute("account", accountUserDetails.getAccount()); 16 | return "index"; 17 | } 18 | 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/example/account/Account.java: -------------------------------------------------------------------------------- 1 | package com.example.account; 2 | 3 | import java.io.Serializable; 4 | 5 | public record Account(String username, String password, String twoFactorSecret, 6 | boolean twoFactorEnabled) implements Serializable { 7 | 8 | public static Account without2Fa(String username, String password, String twoFactorSecret) { 9 | return new Account(username, password, twoFactorSecret, false); 10 | } 11 | 12 | public Account withPassword(String password) { 13 | return new Account(this.username, password, this.twoFactorSecret, this.twoFactorEnabled); 14 | } 15 | 16 | public Account enable2Fa() { 17 | return new Account(this.username, this.password, twoFactorSecret, true); 18 | } 19 | 20 | } 21 | -------------------------------------------------------------------------------- /src/main/java/com/example/twofactorauth/TwoFactorAuthorizationManager.java: -------------------------------------------------------------------------------- 1 | package com.example.twofactorauth; 2 | 3 | import java.util.function.Supplier; 4 | 5 | import org.springframework.security.authorization.AuthorizationDecision; 6 | import org.springframework.security.authorization.AuthorizationManager; 7 | import org.springframework.security.core.Authentication; 8 | import org.springframework.security.web.access.intercept.RequestAuthorizationContext; 9 | 10 | public class TwoFactorAuthorizationManager implements AuthorizationManager { 11 | 12 | @Override 13 | public AuthorizationDecision check(Supplier authentication, RequestAuthorizationContext object) { 14 | return new AuthorizationDecision(authentication.get() instanceof TwoFactorAuthentication); 15 | } 16 | 17 | } 18 | -------------------------------------------------------------------------------- /src/main/java/com/example/twofactorauth/totp/TotpAuthenticationCodeVerifier.java: -------------------------------------------------------------------------------- 1 | package com.example.twofactorauth.totp; 2 | 3 | import java.security.GeneralSecurityException; 4 | 5 | import com.example.account.Account; 6 | import com.example.twofactorauth.TwoFactorAuthenticationCodeVerifier; 7 | import com.j256.twofactorauth.TimeBasedOneTimePasswordUtil; 8 | 9 | import org.springframework.util.StringUtils; 10 | 11 | public class TotpAuthenticationCodeVerifier implements TwoFactorAuthenticationCodeVerifier { 12 | 13 | @Override 14 | public boolean verify(Account account, String code) { 15 | try { 16 | return TimeBasedOneTimePasswordUtil.validateCurrentNumber(account.twoFactorSecret(), 17 | StringUtils.hasText(code) ? Integer.parseInt(code) : 0, 10000); 18 | } 19 | catch (GeneralSecurityException e) { 20 | throw new IllegalStateException(e); 21 | } 22 | } 23 | 24 | } 25 | -------------------------------------------------------------------------------- /src/main/java/com/example/account/AccountUserDetailsService.java: -------------------------------------------------------------------------------- 1 | package com.example.account; 2 | 3 | import org.springframework.dao.EmptyResultDataAccessException; 4 | import org.springframework.security.core.userdetails.UserDetails; 5 | import org.springframework.security.core.userdetails.UserDetailsService; 6 | import org.springframework.security.core.userdetails.UsernameNotFoundException; 7 | import org.springframework.stereotype.Service; 8 | 9 | @Service 10 | public class AccountUserDetailsService implements UserDetailsService { 11 | 12 | private final AccountService accountService; 13 | 14 | public AccountUserDetailsService(AccountService accountService) { 15 | this.accountService = accountService; 16 | } 17 | 18 | @Override 19 | public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { 20 | try { 21 | Account account = this.accountService.findByUsername(username); 22 | return new AccountUserDetails(account); 23 | } 24 | catch (EmptyResultDataAccessException e) { 25 | throw new UsernameNotFoundException("user not found", e); 26 | } 27 | } 28 | 29 | } 30 | -------------------------------------------------------------------------------- /src/main/java/com/example/twofactorauth/TwoFactorAuthentication.java: -------------------------------------------------------------------------------- 1 | package com.example.twofactorauth; 2 | 3 | import java.util.List; 4 | 5 | import org.springframework.security.authentication.AbstractAuthenticationToken; 6 | import org.springframework.security.core.Authentication; 7 | import org.springframework.security.core.CredentialsContainer; 8 | 9 | public class TwoFactorAuthentication extends AbstractAuthenticationToken { 10 | 11 | private final Authentication primary; 12 | 13 | public TwoFactorAuthentication(Authentication primary) { 14 | super(List.of()); 15 | this.primary = primary; 16 | } 17 | 18 | public Object getPrincipal() { 19 | return this.primary.getPrincipal(); 20 | } 21 | 22 | @Override 23 | public Object getCredentials() { 24 | return this.primary.getCredentials(); 25 | } 26 | 27 | @Override 28 | public void eraseCredentials() { 29 | if (this.primary instanceof CredentialsContainer) { 30 | ((CredentialsContainer) this.primary).eraseCredentials(); 31 | } 32 | } 33 | 34 | @Override 35 | public boolean isAuthenticated() { 36 | return false; 37 | } 38 | 39 | public Authentication getPrimary() { 40 | return this.primary; 41 | } 42 | 43 | } 44 | -------------------------------------------------------------------------------- /src/main/resources/templates/index.mustache: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Welcome 6 | 7 | 9 | 10 | 11 | 12 | {{#account}} 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 26 | 27 |
Username{{account.username}}
2FA Enabled{{account.twoFactorEnabled}} 21 | {{^account.twoFactorEnabled}} 22 |
23 | Enable 2FA 24 | {{/account.twoFactorEnabled}} 25 |
28 | {{/account}} 29 |
30 | Log Out 31 | 32 | -------------------------------------------------------------------------------- /src/main/java/com/example/account/AccountService.java: -------------------------------------------------------------------------------- 1 | package com.example.account; 2 | 3 | import org.springframework.jdbc.core.DataClassRowMapper; 4 | import org.springframework.jdbc.core.JdbcTemplate; 5 | import org.springframework.stereotype.Service; 6 | import org.springframework.transaction.annotation.Transactional; 7 | 8 | @Service 9 | public class AccountService { 10 | 11 | private final JdbcTemplate jdbcTemplate; 12 | 13 | public AccountService(JdbcTemplate jdbcTemplate) { 14 | this.jdbcTemplate = jdbcTemplate; 15 | } 16 | 17 | public Account findByUsername(String username) { 18 | return this.jdbcTemplate.queryForObject( 19 | "SELECT username, password, two_factor_secret, two_factor_enabled FROM account WHERE username = ?", 20 | new DataClassRowMapper<>(Account.class), username); 21 | } 22 | 23 | @Transactional 24 | public int insert(Account account) { 25 | return this.jdbcTemplate.update( 26 | "INSERT INTO account(username, password, two_factor_secret, two_factor_enabled) VALUES (?, ?, ?, ?)", 27 | account.username(), account.password(), account.twoFactorSecret(), account.twoFactorEnabled()); 28 | } 29 | 30 | @Transactional 31 | public Account enable2Fa(Account account) { 32 | this.jdbcTemplate.update("UPDATE account SET two_factor_enabled = true WHERE username = ?", account.username()); 33 | return account.enable2Fa(); 34 | } 35 | 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/com/example/account/AccountUserDetails.java: -------------------------------------------------------------------------------- 1 | package com.example.account; 2 | 3 | import java.util.Collection; 4 | 5 | import org.springframework.security.core.GrantedAuthority; 6 | import org.springframework.security.core.authority.AuthorityUtils; 7 | import org.springframework.security.core.userdetails.UserDetails; 8 | 9 | public class AccountUserDetails implements UserDetails { 10 | 11 | private final Account account; 12 | 13 | public AccountUserDetails(Account account) { 14 | this.account = account; 15 | } 16 | 17 | public Account getAccount() { 18 | return account; 19 | } 20 | 21 | @Override 22 | public Collection getAuthorities() { 23 | return AuthorityUtils.createAuthorityList("ROLE_USER"); 24 | } 25 | 26 | @Override 27 | public String getPassword() { 28 | return this.account.password(); 29 | } 30 | 31 | @Override 32 | public String getUsername() { 33 | return this.account.username(); 34 | } 35 | 36 | @Override 37 | public boolean isAccountNonExpired() { 38 | return true; 39 | } 40 | 41 | @Override 42 | public boolean isAccountNonLocked() { 43 | return true; 44 | } 45 | 46 | @Override 47 | public boolean isCredentialsNonExpired() { 48 | return true; 49 | } 50 | 51 | @Override 52 | public boolean isEnabled() { 53 | return true; 54 | } 55 | 56 | @Override 57 | public String toString() { 58 | return "AccountUserDetails{" + "account=" + account + '}'; 59 | } 60 | 61 | } 62 | -------------------------------------------------------------------------------- /src/main/resources/templates/totp.mustache: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Welcome 6 | 7 | 9 | 10 | 11 | 12 |
13 | 28 |
29 | 30 | -------------------------------------------------------------------------------- /src/main/resources/templates/signup.mustache: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Signup 6 | 7 | 9 | 10 | 11 | 12 |
13 | 27 |
28 | 29 | 30 | -------------------------------------------------------------------------------- /src/main/java/com/example/twofactorauth/totp/QrCode.java: -------------------------------------------------------------------------------- 1 | package com.example.twofactorauth.totp; 2 | 3 | import java.io.ByteArrayOutputStream; 4 | import java.io.IOException; 5 | import java.util.Base64; 6 | import java.util.Collections; 7 | import java.util.Map; 8 | 9 | import com.google.zxing.BarcodeFormat; 10 | import com.google.zxing.EncodeHintType; 11 | import com.google.zxing.WriterException; 12 | import com.google.zxing.client.j2se.MatrixToImageConfig; 13 | import com.google.zxing.client.j2se.MatrixToImageWriter; 14 | import com.google.zxing.common.BitMatrix; 15 | import com.google.zxing.qrcode.QRCodeWriter; 16 | import com.google.zxing.qrcode.decoder.ErrorCorrectionLevel; 17 | 18 | import org.springframework.stereotype.Component; 19 | 20 | @Component 21 | public class QrCode { 22 | 23 | private final QRCodeWriter writer = new QRCodeWriter(); 24 | 25 | private final Map hints = Collections.singletonMap(EncodeHintType.ERROR_CORRECTION, 26 | ErrorCorrectionLevel.M); 27 | 28 | private final MatrixToImageConfig config; 29 | 30 | private final int size; 31 | 32 | public QrCode() { 33 | this.config = new MatrixToImageConfig(); 34 | this.size = 200; 35 | } 36 | 37 | public String dataUrl(String url) { 38 | try (ByteArrayOutputStream output = new ByteArrayOutputStream()) { 39 | BitMatrix bitMatrix = this.writer.encode(url, BarcodeFormat.QR_CODE, size, size, hints); 40 | MatrixToImageWriter.writeToStream(bitMatrix, "png", output, this.config); 41 | return "data:image/png;base64,%s".formatted(Base64.getEncoder().encodeToString(output.toByteArray())); 42 | } 43 | catch (WriterException | IOException e) { 44 | throw new IllegalStateException(e); 45 | } 46 | } 47 | 48 | } -------------------------------------------------------------------------------- /src/main/java/com/example/twofactorauth/TwoFactorAuthenticationSuccessHandler.java: -------------------------------------------------------------------------------- 1 | package com.example.twofactorauth; 2 | 3 | import java.io.IOException; 4 | 5 | import com.example.account.Account; 6 | import com.example.account.AccountUserDetails; 7 | import jakarta.servlet.ServletException; 8 | import jakarta.servlet.http.HttpServletRequest; 9 | import jakarta.servlet.http.HttpServletResponse; 10 | 11 | import org.springframework.security.core.Authentication; 12 | import org.springframework.security.core.context.SecurityContextHolder; 13 | import org.springframework.security.web.authentication.AuthenticationSuccessHandler; 14 | import org.springframework.security.web.authentication.SimpleUrlAuthenticationSuccessHandler; 15 | 16 | public class TwoFactorAuthenticationSuccessHandler implements AuthenticationSuccessHandler { 17 | 18 | private final AuthenticationSuccessHandler primarySuccessHandler; 19 | 20 | private final AuthenticationSuccessHandler secondarySuccessHandler; 21 | 22 | public TwoFactorAuthenticationSuccessHandler(String secondAuthUrl, 23 | AuthenticationSuccessHandler primarySuccessHandler) { 24 | this.primarySuccessHandler = primarySuccessHandler; 25 | this.secondarySuccessHandler = new SimpleUrlAuthenticationSuccessHandler(secondAuthUrl); 26 | } 27 | 28 | @Override 29 | public void onAuthenticationSuccess(HttpServletRequest request, HttpServletResponse response, 30 | Authentication authentication) throws IOException, ServletException { 31 | AccountUserDetails accountUserDetails = (AccountUserDetails) authentication.getPrincipal(); 32 | Account account = accountUserDetails.getAccount(); 33 | if (account.twoFactorEnabled()) { 34 | SecurityContextHolder.getContext().setAuthentication(new TwoFactorAuthentication(authentication)); 35 | this.secondarySuccessHandler.onAuthenticationSuccess(request, response, authentication); 36 | } 37 | else { 38 | this.primarySuccessHandler.onAuthenticationSuccess(request, response, authentication); 39 | } 40 | } 41 | 42 | } 43 | -------------------------------------------------------------------------------- /src/main/java/com/example/account/web/SignupController.java: -------------------------------------------------------------------------------- 1 | package com.example.account.web; 2 | 3 | import com.example.account.Account; 4 | import com.example.account.AccountService; 5 | import com.example.account.AccountUserDetails; 6 | import com.j256.twofactorauth.TimeBasedOneTimePasswordUtil; 7 | 8 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; 9 | import org.springframework.security.core.Authentication; 10 | import org.springframework.security.core.context.SecurityContextHolder; 11 | import org.springframework.security.crypto.password.PasswordEncoder; 12 | import org.springframework.stereotype.Controller; 13 | import org.springframework.web.bind.annotation.GetMapping; 14 | import org.springframework.web.bind.annotation.PostMapping; 15 | 16 | @Controller 17 | public class SignupController { 18 | 19 | private final AccountService accountService; 20 | 21 | private final PasswordEncoder passwordEncoder; 22 | 23 | public SignupController(AccountService accountService, PasswordEncoder passwordEncoder) { 24 | this.accountService = accountService; 25 | this.passwordEncoder = passwordEncoder; 26 | } 27 | 28 | @GetMapping(path = "/signup") 29 | public String signup() { 30 | return "signup"; 31 | } 32 | 33 | @PostMapping(path = "/signup") 34 | public String signup(SignupForm form) { 35 | String encoded = this.passwordEncoder.encode(form.password()); 36 | String secret = TimeBasedOneTimePasswordUtil.generateBase32Secret(); 37 | Account account = Account.without2Fa(form.username(), encoded, secret); 38 | this.accountService.insert(account); 39 | 40 | // automatic login after signup 41 | AccountUserDetails userDetails = new AccountUserDetails(account); 42 | Authentication token = UsernamePasswordAuthenticationToken.authenticated(userDetails, null, 43 | userDetails.getAuthorities()); 44 | SecurityContextHolder.getContext().setAuthentication(token); 45 | return "redirect:/"; 46 | } 47 | 48 | record SignupForm(String username, String password) { 49 | } 50 | 51 | } 52 | -------------------------------------------------------------------------------- /src/main/resources/templates/enable-2fa.mustache: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Welcome 6 | 7 | 9 | 10 | 11 | 12 |
13 |

Setup authenticator app

14 |

15 | Authenticator apps like Google Authenticator generate one-time passwords as a second factor for verifying your 16 | identity when prompted during the sign-in process. 17 |

18 |

19 | Use an authenticator app to scan the QR code. 20 |

21 | 22 | 23 | 24 |
25 |
26 | 27 | Having trouble scanning? You can utilize the setup 29 | key to manually set up your authenticator app. 30 |
31 | 32 | 38 |
39 |

40 | Verify the code from the app 41 |

42 | {{#message}} 43 | 44 | {{/message}} 45 | 46 |
47 | 48 | 49 | 50 | {{#_csrf}} 51 | 52 | {{/_csrf}} 53 |
54 | 55 |
56 |
57 | 58 | -------------------------------------------------------------------------------- /src/main/java/com/example/SecurityConfig.java: -------------------------------------------------------------------------------- 1 | package com.example; 2 | 3 | import com.example.twofactorauth.TwoFactorAuthenticationCodeVerifier; 4 | import com.example.twofactorauth.TwoFactorAuthenticationSuccessHandler; 5 | import com.example.twofactorauth.TwoFactorAuthorizationManager; 6 | import com.example.twofactorauth.totp.TotpAuthenticationCodeVerifier; 7 | 8 | import org.springframework.context.annotation.Bean; 9 | import org.springframework.context.annotation.Configuration; 10 | import org.springframework.security.config.annotation.web.builders.HttpSecurity; 11 | import org.springframework.security.crypto.factory.PasswordEncoderFactories; 12 | import org.springframework.security.crypto.password.PasswordEncoder; 13 | import org.springframework.security.web.SecurityFilterChain; 14 | import org.springframework.security.web.authentication.AuthenticationFailureHandler; 15 | import org.springframework.security.web.authentication.AuthenticationSuccessHandler; 16 | import org.springframework.security.web.authentication.SavedRequestAwareAuthenticationSuccessHandler; 17 | import org.springframework.security.web.authentication.SimpleUrlAuthenticationFailureHandler; 18 | 19 | @Configuration 20 | public class SecurityConfig { 21 | 22 | @Bean 23 | public SecurityFilterChain securityFilterChain(HttpSecurity http, 24 | AuthenticationSuccessHandler primarySuccessHandler) throws Exception { 25 | return http 26 | // @formatter:off 27 | .authorizeHttpRequests(authorize -> authorize 28 | .requestMatchers("/signup", "/error").permitAll() 29 | .requestMatchers("/challenge/totp").access(new TwoFactorAuthorizationManager()) 30 | .anyRequest().authenticated()) 31 | // @formatter:on 32 | .formLogin(form -> form 33 | .successHandler(new TwoFactorAuthenticationSuccessHandler("/challenge/totp", primarySuccessHandler))) 34 | .securityContext(securityContext -> securityContext.requireExplicitSave(false)) 35 | .build(); 36 | } 37 | 38 | @Bean 39 | public PasswordEncoder passwordEncoder() { 40 | return PasswordEncoderFactories.createDelegatingPasswordEncoder(); 41 | } 42 | 43 | @Bean 44 | public AuthenticationSuccessHandler primarySuccessHandler() { 45 | return new SavedRequestAwareAuthenticationSuccessHandler(); 46 | } 47 | 48 | @Bean 49 | public AuthenticationFailureHandler primaryFailureHandler() { 50 | return new SimpleUrlAuthenticationFailureHandler("/login?error"); 51 | } 52 | 53 | @Bean 54 | public TwoFactorAuthenticationCodeVerifier twoFactorAuthenticationCodeVerifier() { 55 | return new TotpAuthenticationCodeVerifier(); 56 | } 57 | 58 | } 59 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Two-Factor Authentication Demo with Spring Security 2 | 3 | 4 | Visit http://localhost:8080/signup to register for an account. 5 | 6 | image 7 | 8 | 2FA is disabled by default. 9 | 10 | image 11 | 12 | Log out. 13 | 14 | image 15 | 16 | Log in again. 17 | 18 | image 19 | 20 | 2FA is disabled, so login is successful with only username and password. 21 | 22 | image 23 | 24 | Enable 2FA. 25 | 26 | image 27 | 28 | Read the QR code using Google Authenticator. 29 | 30 | ![image](https://github.com/making/blog.ik.am/assets/106908/a1a51abd-6b93-4210-a004-75a801d04040) 31 | 32 | Check the code. 33 | 34 | ![image](https://github.com/making/blog.ik.am/assets/106908/542691b9-f8d3-4a5a-bd0b-51a711f59fae) 35 | 36 | Enter the code and click the verify button. 37 | 38 | image 39 | 40 | 2FA has been enabled. 41 | 42 | image 43 | 44 | Log out. 45 | 46 | image 47 | 48 | Log in again. 49 | 50 | image 51 | 52 | This time, 2FA is enabled, so you will be asked to enter a code. 53 | 54 | image 55 | 56 | Check the code with Google Authenticator. 57 | 58 | ![image](https://github.com/making/blog.ik.am/assets/106908/3b1d7927-5c50-4732-a0dd-c4274934f4be) 59 | 60 | Enter the code and click the verify button. 61 | 62 | image 63 | 64 | Login was successful. 65 | 66 | image -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | org.springframework.boot 7 | spring-boot-starter-parent 8 | 3.1.3 9 | 10 | 11 | com.example 12 | demo-two-factor-authentication 13 | 0.0.1-SNAPSHOT 14 | demo-two-factor-authentication 15 | demo-two-factor-authentication 16 | 17 | 17 18 | 2.0 19 | 20 | 21 | 22 | org.springframework.boot 23 | spring-boot-starter-actuator 24 | 25 | 26 | org.springframework.boot 27 | spring-boot-starter-jdbc 28 | 29 | 30 | org.springframework.boot 31 | spring-boot-starter-mustache 32 | 33 | 34 | org.springframework.boot 35 | spring-boot-starter-security 36 | 37 | 38 | org.springframework.boot 39 | spring-boot-starter-web 40 | 41 | 42 | 43 | 44 | 45 | 46 | org.springframework.boot 47 | spring-boot-docker-compose 48 | runtime 49 | true 50 | 51 | 52 | com.j256.two-factor-auth 53 | two-factor-auth 54 | 1.3 55 | 56 | 57 | com.google.zxing 58 | javase 59 | 3.5.2 60 | 61 | 62 | org.postgresql 63 | postgresql 64 | runtime 65 | 66 | 67 | io.micrometer 68 | micrometer-registry-prometheus 69 | runtime 70 | 71 | 72 | org.springframework.boot 73 | spring-boot-configuration-processor 74 | true 75 | 76 | 77 | org.springframework.boot 78 | spring-boot-starter-test 79 | test 80 | 81 | 82 | org.springframework.boot 83 | spring-boot-testcontainers 84 | test 85 | 86 | 87 | org.testcontainers 88 | junit-jupiter 89 | test 90 | 91 | 92 | org.testcontainers 93 | postgresql 94 | test 95 | 96 | 97 | org.springframework.security 98 | spring-security-test 99 | test 100 | 101 | 102 | 103 | 104 | 105 | 106 | org.springframework.boot 107 | spring-boot-maven-plugin 108 | 109 | 110 | io.spring.javaformat 111 | spring-javaformat-maven-plugin 112 | 0.0.39 113 | 114 | 115 | validate 116 | true 117 | 118 | validate 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | -------------------------------------------------------------------------------- /src/main/java/com/example/twofactorauth/web/TwoFactorAuthController.java: -------------------------------------------------------------------------------- 1 | package com.example.twofactorauth.web; 2 | 3 | import java.io.IOException; 4 | 5 | import com.example.account.Account; 6 | import com.example.account.AccountService; 7 | import com.example.account.AccountUserDetails; 8 | import com.example.twofactorauth.TwoFactorAuthentication; 9 | import com.example.twofactorauth.TwoFactorAuthenticationCodeVerifier; 10 | import com.example.twofactorauth.totp.QrCode; 11 | import jakarta.servlet.ServletException; 12 | import jakarta.servlet.http.HttpServletRequest; 13 | import jakarta.servlet.http.HttpServletResponse; 14 | 15 | import org.springframework.security.authentication.BadCredentialsException; 16 | import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; 17 | import org.springframework.security.core.Authentication; 18 | import org.springframework.security.core.annotation.AuthenticationPrincipal; 19 | import org.springframework.security.core.context.SecurityContextHolder; 20 | import org.springframework.security.web.authentication.AuthenticationFailureHandler; 21 | import org.springframework.security.web.authentication.AuthenticationSuccessHandler; 22 | import org.springframework.stereotype.Controller; 23 | import org.springframework.ui.Model; 24 | import org.springframework.web.bind.annotation.GetMapping; 25 | import org.springframework.web.bind.annotation.PostMapping; 26 | import org.springframework.web.bind.annotation.RequestParam; 27 | 28 | @Controller 29 | public class TwoFactorAuthController { 30 | 31 | private final AccountService accountService; 32 | 33 | private final TwoFactorAuthenticationCodeVerifier codeVerifier; 34 | 35 | private final QrCode qrCode; 36 | 37 | private final AuthenticationSuccessHandler successHandler; 38 | 39 | private final AuthenticationFailureHandler failureHandler; 40 | 41 | public TwoFactorAuthController(AccountService accountService, TwoFactorAuthenticationCodeVerifier codeVerifier, 42 | QrCode qrCode, AuthenticationSuccessHandler successHandler, AuthenticationFailureHandler failureHandler) { 43 | this.accountService = accountService; 44 | this.codeVerifier = codeVerifier; 45 | this.qrCode = qrCode; 46 | this.successHandler = successHandler; 47 | this.failureHandler = failureHandler; 48 | } 49 | 50 | @GetMapping(path = "/enable-2fa") 51 | public String requestEnableTwoFactor(@AuthenticationPrincipal AccountUserDetails accountUserDetails, Model model) { 52 | Account account = accountUserDetails.getAccount(); 53 | String otpAuthUrl = "otpauth://totp/%s?secret=%s&digits=6".formatted("Demo: " + account.username(), 54 | account.twoFactorSecret()); 55 | model.addAttribute("qrCode", this.qrCode.dataUrl(otpAuthUrl)); 56 | model.addAttribute("secret", account.twoFactorSecret()); 57 | return "enable-2fa"; 58 | } 59 | 60 | @PostMapping(path = "/enable-2fa") 61 | public String processEnableTwoFactor(@RequestParam String code, 62 | @AuthenticationPrincipal AccountUserDetails accountUserDetails, Model model) { 63 | Account account = accountUserDetails.getAccount(); 64 | if (account.twoFactorEnabled()) { 65 | return "redirect:/"; 66 | } 67 | if (!this.codeVerifier.verify(account, code)) { 68 | model.addAttribute("message", "Invalid code"); 69 | return this.requestEnableTwoFactor(accountUserDetails, model); 70 | } 71 | Account enabled = this.accountService.enable2Fa(account); 72 | Authentication token = UsernamePasswordAuthenticationToken.authenticated(new AccountUserDetails(enabled), null, 73 | accountUserDetails.getAuthorities()); 74 | SecurityContextHolder.getContext().setAuthentication(token); 75 | return "redirect:/"; 76 | } 77 | 78 | @GetMapping(path = "/challenge/totp") 79 | public String requestTotp() { 80 | return "totp"; 81 | } 82 | 83 | @PostMapping(path = "/challenge/totp") 84 | public void processTotp(@RequestParam String code, TwoFactorAuthentication authentication, 85 | HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { 86 | Authentication primaryAuthentication = authentication.getPrimary(); 87 | AccountUserDetails accountUserDetails = (AccountUserDetails) primaryAuthentication.getPrincipal(); 88 | Account account = accountUserDetails.getAccount(); 89 | if (this.codeVerifier.verify(account, code)) { 90 | SecurityContextHolder.getContext().setAuthentication(primaryAuthentication); 91 | this.successHandler.onAuthenticationSuccess(request, response, primaryAuthentication); 92 | } 93 | else { 94 | this.failureHandler.onAuthenticationFailure(request, response, new BadCredentialsException("Invalid code")); 95 | } 96 | } 97 | 98 | } 99 | -------------------------------------------------------------------------------- /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 Apache Maven Wrapper startup batch script, version 3.2.0 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 MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands 28 | @REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending 29 | @REM MAVEN_OPTS - parameters passed to the Java VM when running Maven 30 | @REM e.g. to debug Maven itself, use 31 | @REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 32 | @REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files 33 | @REM ---------------------------------------------------------------------------- 34 | 35 | @REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on' 36 | @echo off 37 | @REM set title of command window 38 | title %0 39 | @REM enable echoing by setting MAVEN_BATCH_ECHO to 'on' 40 | @if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO% 41 | 42 | @REM set %HOME% to equivalent of $HOME 43 | if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%") 44 | 45 | @REM Execute a user defined script before this one 46 | if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre 47 | @REM check for pre script, once with legacy .bat ending and once with .cmd ending 48 | if exist "%USERPROFILE%\mavenrc_pre.bat" call "%USERPROFILE%\mavenrc_pre.bat" %* 49 | if exist "%USERPROFILE%\mavenrc_pre.cmd" call "%USERPROFILE%\mavenrc_pre.cmd" %* 50 | :skipRcPre 51 | 52 | @setlocal 53 | 54 | set ERROR_CODE=0 55 | 56 | @REM To isolate internal variables from possible post scripts, we use another setlocal 57 | @setlocal 58 | 59 | @REM ==== START VALIDATION ==== 60 | if not "%JAVA_HOME%" == "" goto OkJHome 61 | 62 | echo. 63 | echo Error: JAVA_HOME not found in your environment. >&2 64 | echo Please set the JAVA_HOME variable in your environment to match the >&2 65 | echo location of your Java installation. >&2 66 | echo. 67 | goto error 68 | 69 | :OkJHome 70 | if exist "%JAVA_HOME%\bin\java.exe" goto init 71 | 72 | echo. 73 | echo Error: JAVA_HOME is set to an invalid directory. >&2 74 | echo JAVA_HOME = "%JAVA_HOME%" >&2 75 | echo Please set the JAVA_HOME variable in your environment to match the >&2 76 | echo location of your Java installation. >&2 77 | echo. 78 | goto error 79 | 80 | @REM ==== END VALIDATION ==== 81 | 82 | :init 83 | 84 | @REM Find the project base dir, i.e. the directory that contains the folder ".mvn". 85 | @REM Fallback to current working directory if not found. 86 | 87 | set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR% 88 | IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir 89 | 90 | set EXEC_DIR=%CD% 91 | set WDIR=%EXEC_DIR% 92 | :findBaseDir 93 | IF EXIST "%WDIR%"\.mvn goto baseDirFound 94 | cd .. 95 | IF "%WDIR%"=="%CD%" goto baseDirNotFound 96 | set WDIR=%CD% 97 | goto findBaseDir 98 | 99 | :baseDirFound 100 | set MAVEN_PROJECTBASEDIR=%WDIR% 101 | cd "%EXEC_DIR%" 102 | goto endDetectBaseDir 103 | 104 | :baseDirNotFound 105 | set MAVEN_PROJECTBASEDIR=%EXEC_DIR% 106 | cd "%EXEC_DIR%" 107 | 108 | :endDetectBaseDir 109 | 110 | IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig 111 | 112 | @setlocal EnableExtensions EnableDelayedExpansion 113 | for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a 114 | @endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS% 115 | 116 | :endReadAdditionalConfig 117 | 118 | SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe" 119 | set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar" 120 | set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 121 | 122 | set WRAPPER_URL="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 123 | 124 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 125 | IF "%%A"=="wrapperUrl" SET WRAPPER_URL=%%B 126 | ) 127 | 128 | @REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 129 | @REM This allows using the maven wrapper in projects that prohibit checking in binary data. 130 | if exist %WRAPPER_JAR% ( 131 | if "%MVNW_VERBOSE%" == "true" ( 132 | echo Found %WRAPPER_JAR% 133 | ) 134 | ) else ( 135 | if not "%MVNW_REPOURL%" == "" ( 136 | SET WRAPPER_URL="%MVNW_REPOURL%/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 137 | ) 138 | if "%MVNW_VERBOSE%" == "true" ( 139 | echo Couldn't find %WRAPPER_JAR%, downloading it ... 140 | echo Downloading from: %WRAPPER_URL% 141 | ) 142 | 143 | powershell -Command "&{"^ 144 | "$webclient = new-object System.Net.WebClient;"^ 145 | "if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^ 146 | "$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^ 147 | "}"^ 148 | "[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%WRAPPER_URL%', '%WRAPPER_JAR%')"^ 149 | "}" 150 | if "%MVNW_VERBOSE%" == "true" ( 151 | echo Finished downloading %WRAPPER_JAR% 152 | ) 153 | ) 154 | @REM End of extension 155 | 156 | @REM If specified, validate the SHA-256 sum of the Maven wrapper jar file 157 | SET WRAPPER_SHA_256_SUM="" 158 | FOR /F "usebackq tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO ( 159 | IF "%%A"=="wrapperSha256Sum" SET WRAPPER_SHA_256_SUM=%%B 160 | ) 161 | IF NOT %WRAPPER_SHA_256_SUM%=="" ( 162 | powershell -Command "&{"^ 163 | "$hash = (Get-FileHash \"%WRAPPER_JAR%\" -Algorithm SHA256).Hash.ToLower();"^ 164 | "If('%WRAPPER_SHA_256_SUM%' -ne $hash){"^ 165 | " Write-Output 'Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised.';"^ 166 | " Write-Output 'Investigate or delete %WRAPPER_JAR% to attempt a clean download.';"^ 167 | " Write-Output 'If you updated your Maven version, you need to update the specified wrapperSha256Sum property.';"^ 168 | " exit 1;"^ 169 | "}"^ 170 | "}" 171 | if ERRORLEVEL 1 goto error 172 | ) 173 | 174 | @REM Provide a "standardized" way to retrieve the CLI args that will 175 | @REM work with both Windows and non-Windows executions. 176 | set MAVEN_CMD_LINE_ARGS=%* 177 | 178 | %MAVEN_JAVA_EXE% ^ 179 | %JVM_CONFIG_MAVEN_PROPS% ^ 180 | %MAVEN_OPTS% ^ 181 | %MAVEN_DEBUG_OPTS% ^ 182 | -classpath %WRAPPER_JAR% ^ 183 | "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" ^ 184 | %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %* 185 | if ERRORLEVEL 1 goto error 186 | goto end 187 | 188 | :error 189 | set ERROR_CODE=1 190 | 191 | :end 192 | @endlocal & set ERROR_CODE=%ERROR_CODE% 193 | 194 | if not "%MAVEN_SKIP_RC%"=="" goto skipRcPost 195 | @REM check for post script, once with legacy .bat ending and once with .cmd ending 196 | if exist "%USERPROFILE%\mavenrc_post.bat" call "%USERPROFILE%\mavenrc_post.bat" 197 | if exist "%USERPROFILE%\mavenrc_post.cmd" call "%USERPROFILE%\mavenrc_post.cmd" 198 | :skipRcPost 199 | 200 | @REM pause the script if MAVEN_BATCH_PAUSE is set to 'on' 201 | if "%MAVEN_BATCH_PAUSE%"=="on" pause 202 | 203 | if "%MAVEN_TERMINATE_CMD%"=="on" exit %ERROR_CODE% 204 | 205 | cmd /C exit /B %ERROR_CODE% 206 | -------------------------------------------------------------------------------- /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 | # Apache Maven Wrapper startup batch script, version 3.2.0 23 | # 24 | # Required ENV vars: 25 | # ------------------ 26 | # JAVA_HOME - location of a JDK home dir 27 | # 28 | # Optional ENV vars 29 | # ----------------- 30 | # MAVEN_OPTS - parameters passed to the Java VM when running Maven 31 | # e.g. to debug Maven itself, use 32 | # set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000 33 | # MAVEN_SKIP_RC - flag to disable loading of mavenrc files 34 | # ---------------------------------------------------------------------------- 35 | 36 | if [ -z "$MAVEN_SKIP_RC" ] ; then 37 | 38 | if [ -f /usr/local/etc/mavenrc ] ; then 39 | . /usr/local/etc/mavenrc 40 | fi 41 | 42 | if [ -f /etc/mavenrc ] ; then 43 | . /etc/mavenrc 44 | fi 45 | 46 | if [ -f "$HOME/.mavenrc" ] ; then 47 | . "$HOME/.mavenrc" 48 | fi 49 | 50 | fi 51 | 52 | # OS specific support. $var _must_ be set to either true or false. 53 | cygwin=false; 54 | darwin=false; 55 | mingw=false 56 | case "$(uname)" in 57 | CYGWIN*) cygwin=true ;; 58 | MINGW*) mingw=true;; 59 | Darwin*) darwin=true 60 | # Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home 61 | # See https://developer.apple.com/library/mac/qa/qa1170/_index.html 62 | if [ -z "$JAVA_HOME" ]; then 63 | if [ -x "/usr/libexec/java_home" ]; then 64 | JAVA_HOME="$(/usr/libexec/java_home)"; export JAVA_HOME 65 | else 66 | JAVA_HOME="/Library/Java/Home"; export JAVA_HOME 67 | fi 68 | fi 69 | ;; 70 | esac 71 | 72 | if [ -z "$JAVA_HOME" ] ; then 73 | if [ -r /etc/gentoo-release ] ; then 74 | JAVA_HOME=$(java-config --jre-home) 75 | fi 76 | fi 77 | 78 | # For Cygwin, ensure paths are in UNIX format before anything is touched 79 | if $cygwin ; then 80 | [ -n "$JAVA_HOME" ] && 81 | JAVA_HOME=$(cygpath --unix "$JAVA_HOME") 82 | [ -n "$CLASSPATH" ] && 83 | CLASSPATH=$(cygpath --path --unix "$CLASSPATH") 84 | fi 85 | 86 | # For Mingw, ensure paths are in UNIX format before anything is touched 87 | if $mingw ; then 88 | [ -n "$JAVA_HOME" ] && [ -d "$JAVA_HOME" ] && 89 | JAVA_HOME="$(cd "$JAVA_HOME" || (echo "cannot cd into $JAVA_HOME."; exit 1); pwd)" 90 | fi 91 | 92 | if [ -z "$JAVA_HOME" ]; then 93 | javaExecutable="$(which javac)" 94 | if [ -n "$javaExecutable" ] && ! [ "$(expr "\"$javaExecutable\"" : '\([^ ]*\)')" = "no" ]; then 95 | # readlink(1) is not available as standard on Solaris 10. 96 | readLink=$(which readlink) 97 | if [ ! "$(expr "$readLink" : '\([^ ]*\)')" = "no" ]; then 98 | if $darwin ; then 99 | javaHome="$(dirname "\"$javaExecutable\"")" 100 | javaExecutable="$(cd "\"$javaHome\"" && pwd -P)/javac" 101 | else 102 | javaExecutable="$(readlink -f "\"$javaExecutable\"")" 103 | fi 104 | javaHome="$(dirname "\"$javaExecutable\"")" 105 | javaHome=$(expr "$javaHome" : '\(.*\)/bin') 106 | JAVA_HOME="$javaHome" 107 | export JAVA_HOME 108 | fi 109 | fi 110 | fi 111 | 112 | if [ -z "$JAVACMD" ] ; then 113 | if [ -n "$JAVA_HOME" ] ; then 114 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 115 | # IBM's JDK on AIX uses strange locations for the executables 116 | JAVACMD="$JAVA_HOME/jre/sh/java" 117 | else 118 | JAVACMD="$JAVA_HOME/bin/java" 119 | fi 120 | else 121 | JAVACMD="$(\unset -f command 2>/dev/null; \command -v java)" 122 | fi 123 | fi 124 | 125 | if [ ! -x "$JAVACMD" ] ; then 126 | echo "Error: JAVA_HOME is not defined correctly." >&2 127 | echo " We cannot execute $JAVACMD" >&2 128 | exit 1 129 | fi 130 | 131 | if [ -z "$JAVA_HOME" ] ; then 132 | echo "Warning: JAVA_HOME environment variable is not set." 133 | fi 134 | 135 | # traverses directory structure from process work directory to filesystem root 136 | # first directory with .mvn subdirectory is considered project base directory 137 | find_maven_basedir() { 138 | if [ -z "$1" ] 139 | then 140 | echo "Path not specified to find_maven_basedir" 141 | return 1 142 | fi 143 | 144 | basedir="$1" 145 | wdir="$1" 146 | while [ "$wdir" != '/' ] ; do 147 | if [ -d "$wdir"/.mvn ] ; then 148 | basedir=$wdir 149 | break 150 | fi 151 | # workaround for JBEAP-8937 (on Solaris 10/Sparc) 152 | if [ -d "${wdir}" ]; then 153 | wdir=$(cd "$wdir/.." || exit 1; pwd) 154 | fi 155 | # end of workaround 156 | done 157 | printf '%s' "$(cd "$basedir" || exit 1; pwd)" 158 | } 159 | 160 | # concatenates all lines of a file 161 | concat_lines() { 162 | if [ -f "$1" ]; then 163 | # Remove \r in case we run on Windows within Git Bash 164 | # and check out the repository with auto CRLF management 165 | # enabled. Otherwise, we may read lines that are delimited with 166 | # \r\n and produce $'-Xarg\r' rather than -Xarg due to word 167 | # splitting rules. 168 | tr -s '\r\n' ' ' < "$1" 169 | fi 170 | } 171 | 172 | log() { 173 | if [ "$MVNW_VERBOSE" = true ]; then 174 | printf '%s\n' "$1" 175 | fi 176 | } 177 | 178 | BASE_DIR=$(find_maven_basedir "$(dirname "$0")") 179 | if [ -z "$BASE_DIR" ]; then 180 | exit 1; 181 | fi 182 | 183 | MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}; export MAVEN_PROJECTBASEDIR 184 | log "$MAVEN_PROJECTBASEDIR" 185 | 186 | ########################################################################################## 187 | # Extension to allow automatically downloading the maven-wrapper.jar from Maven-central 188 | # This allows using the maven wrapper in projects that prohibit checking in binary data. 189 | ########################################################################################## 190 | wrapperJarPath="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" 191 | if [ -r "$wrapperJarPath" ]; then 192 | log "Found $wrapperJarPath" 193 | else 194 | log "Couldn't find $wrapperJarPath, downloading it ..." 195 | 196 | if [ -n "$MVNW_REPOURL" ]; then 197 | wrapperUrl="$MVNW_REPOURL/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 198 | else 199 | wrapperUrl="https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar" 200 | fi 201 | while IFS="=" read -r key value; do 202 | # Remove '\r' from value to allow usage on windows as IFS does not consider '\r' as a separator ( considers space, tab, new line ('\n'), and custom '=' ) 203 | safeValue=$(echo "$value" | tr -d '\r') 204 | case "$key" in (wrapperUrl) wrapperUrl="$safeValue"; break ;; 205 | esac 206 | done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 207 | log "Downloading from: $wrapperUrl" 208 | 209 | if $cygwin; then 210 | wrapperJarPath=$(cygpath --path --windows "$wrapperJarPath") 211 | fi 212 | 213 | if command -v wget > /dev/null; then 214 | log "Found wget ... using wget" 215 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--quiet" 216 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 217 | wget $QUIET "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 218 | else 219 | wget $QUIET --http-user="$MVNW_USERNAME" --http-password="$MVNW_PASSWORD" "$wrapperUrl" -O "$wrapperJarPath" || rm -f "$wrapperJarPath" 220 | fi 221 | elif command -v curl > /dev/null; then 222 | log "Found curl ... using curl" 223 | [ "$MVNW_VERBOSE" = true ] && QUIET="" || QUIET="--silent" 224 | if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then 225 | curl $QUIET -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 226 | else 227 | curl $QUIET --user "$MVNW_USERNAME:$MVNW_PASSWORD" -o "$wrapperJarPath" "$wrapperUrl" -f -L || rm -f "$wrapperJarPath" 228 | fi 229 | else 230 | log "Falling back to using Java to download" 231 | javaSource="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.java" 232 | javaClass="$MAVEN_PROJECTBASEDIR/.mvn/wrapper/MavenWrapperDownloader.class" 233 | # For Cygwin, switch paths to Windows format before running javac 234 | if $cygwin; then 235 | javaSource=$(cygpath --path --windows "$javaSource") 236 | javaClass=$(cygpath --path --windows "$javaClass") 237 | fi 238 | if [ -e "$javaSource" ]; then 239 | if [ ! -e "$javaClass" ]; then 240 | log " - Compiling MavenWrapperDownloader.java ..." 241 | ("$JAVA_HOME/bin/javac" "$javaSource") 242 | fi 243 | if [ -e "$javaClass" ]; then 244 | log " - Running MavenWrapperDownloader.java ..." 245 | ("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$wrapperUrl" "$wrapperJarPath") || rm -f "$wrapperJarPath" 246 | fi 247 | fi 248 | fi 249 | fi 250 | ########################################################################################## 251 | # End of extension 252 | ########################################################################################## 253 | 254 | # If specified, validate the SHA-256 sum of the Maven wrapper jar file 255 | wrapperSha256Sum="" 256 | while IFS="=" read -r key value; do 257 | case "$key" in (wrapperSha256Sum) wrapperSha256Sum=$value; break ;; 258 | esac 259 | done < "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.properties" 260 | if [ -n "$wrapperSha256Sum" ]; then 261 | wrapperSha256Result=false 262 | if command -v sha256sum > /dev/null; then 263 | if echo "$wrapperSha256Sum $wrapperJarPath" | sha256sum -c > /dev/null 2>&1; then 264 | wrapperSha256Result=true 265 | fi 266 | elif command -v shasum > /dev/null; then 267 | if echo "$wrapperSha256Sum $wrapperJarPath" | shasum -a 256 -c > /dev/null 2>&1; then 268 | wrapperSha256Result=true 269 | fi 270 | else 271 | echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." 272 | echo "Please install either command, or disable validation by removing 'wrapperSha256Sum' from your maven-wrapper.properties." 273 | exit 1 274 | fi 275 | if [ $wrapperSha256Result = false ]; then 276 | echo "Error: Failed to validate Maven wrapper SHA-256, your Maven wrapper might be compromised." >&2 277 | echo "Investigate or delete $wrapperJarPath to attempt a clean download." >&2 278 | echo "If you updated your Maven version, you need to update the specified wrapperSha256Sum property." >&2 279 | exit 1 280 | fi 281 | fi 282 | 283 | MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS" 284 | 285 | # For Cygwin, switch paths to Windows format before running java 286 | if $cygwin; then 287 | [ -n "$JAVA_HOME" ] && 288 | JAVA_HOME=$(cygpath --path --windows "$JAVA_HOME") 289 | [ -n "$CLASSPATH" ] && 290 | CLASSPATH=$(cygpath --path --windows "$CLASSPATH") 291 | [ -n "$MAVEN_PROJECTBASEDIR" ] && 292 | MAVEN_PROJECTBASEDIR=$(cygpath --path --windows "$MAVEN_PROJECTBASEDIR") 293 | fi 294 | 295 | # Provide a "standardized" way to retrieve the CLI args that will 296 | # work with both Windows and non-Windows executions. 297 | MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $*" 298 | export MAVEN_CMD_LINE_ARGS 299 | 300 | WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain 301 | 302 | # shellcheck disable=SC2086 # safe args 303 | exec "$JAVACMD" \ 304 | $MAVEN_OPTS \ 305 | $MAVEN_DEBUG_OPTS \ 306 | -classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \ 307 | "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \ 308 | ${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@" 309 | --------------------------------------------------------------------------------