1. 概述
在本教程中,我们将重点介绍一个非常有趣的安全功能-根据用户的位置保护用户的帐户。
简而言之,我们将阻止任何来自异常或非标准位置的登录,并允许用户以安全的方式启用新位置。
这是注册系列的一部分,自然而然地建立在现有代码库之上。
2. UserLocation模型
首先,让我们看一下我们的UserLocation模型-其中包含有关用户登录位置的信息;每个用户至少有一个与其帐户关联的位置:
@Entity
public class UserLocation {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
private String country;
private boolean enabled;
@ManyToOne(targetEntity = User.class, fetch = FetchType.EAGER)
@JoinColumn(nullable = false, name = "user_id")
private User user;
public UserLocation() {
super();
enabled = false;
}
public UserLocation(String country, User user) {
super();
this.country = country;
this.user = user;
enabled = false;
}
// ...
}
我们将向我们的Repository添加一个简单的检索操作:
public interface UserLocationRepository extends JpaRepository<UserLocation, Long> {
UserLocation findByCountryAndUser(String country, User user);
}
注意
- 默认情况下,新的UserLocation处于禁用状态
- 每个用户至少有一个与其帐户关联的位置,这是他们在注册时访问应用程序的第一个位置
3. 注册
现在,让我们讨论如何修改注册过程以添加默认用户位置:
@PostMapping("/user/registration")
public GenericResponse registerUserAccount(@Valid UserDto accountDto, HttpServletRequest request) {
User registered = userService.registerNewUserAccount(accountDto);
userService.addUserLocation(registered, getClientIP(request));
// ...
}
在服务实现中,我们通过用户的IP地址获取取国家/地区:
public void addUserLocation(User user, String ip) {
InetAddress ipAddress = InetAddress.getByName(ip);
String country = databaseReader.country(ipAddress).getCountry().getName();
UserLocation loc = new UserLocation(country, user);
loc.setEnabled(true);
loc = userLocationRepo.save(loc);
}
请注意,我们使用GeoLite2数据库从IP地址获取国家/地区。要使用GeoLite2,我们需要以下Maven依赖项:
<dependency>
<groupId>com.maxmind.geoip2</groupId>
<artifactId>geoip2</artifactId>
<version>2.15.0</version>
</dependency>
我们还需要定义一个简单的bean:
@Bean
public DatabaseReader databaseReader() throws IOException, GeoIp2Exception {
File resource = new File("src/main/resources/GeoLite2-Country.mmdb");
return new DatabaseReader.Builder(resource).build();
}
我们在这里从MaxMind加载了GeoLite2国家/地区数据库。
4. 安全登录
现在我们有了用户的默认国家/地区,我们将在身份验证后添加一个简单的位置检查器:
@Autowired
private DifferentLocationChecker differentLocationChecker;
@Bean
public DaoAuthenticationProvider authProvider() {
CustomAuthenticationProvider authProvider = new CustomAuthenticationProvider();
authProvider.setUserDetailsService(userDetailsService);
authProvider.setPasswordEncoder(encoder());
authProvider.setPostAuthenticationChecks(differentLocationChecker);
return authProvider;
}
这是我们的DifferentLocationChecker:
@Component
public class DifferentLocationChecker implements UserDetailsChecker {
@Autowired
private IUserService userService;
@Autowired
private HttpServletRequest request;
@Autowired
private ApplicationEventPublisher eventPublisher;
@Override
public void check(UserDetails userDetails) {
String ip = getClientIP();
NewLocationToken token = userService.isNewLoginLocation(userDetails.getUsername(), ip);
if (token != null) {
String appUrl = "http://" + request.getServerName() + ":" + request.getServerPort() + request.getContextPath();
eventPublisher.publishEvent(
new OnDifferentLocationLoginEvent(
request.getLocale(), userDetails.getUsername(), ip, token, appUrl));
throw new UnusualLocationException("unusual location");
}
}
private String getClientIP() {
String xfHeader = request.getHeader("X-Forwarded-For");
if (xfHeader == null) {
return request.getRemoteAddr();
}
return xfHeader.split(",")[0];
}
}
请注意,我们使用了etPostAuthenticationChecks()以便仅在身份验证成功后运行检查-当用户提供正确的凭据时。
此外,我们的自定义UnusualLocationException是一个简单的AuthenticationException。
我们还需要修改AuthenticationFailureHandler以自定义错误消息:
@Override
public void onAuthenticationFailure(...) {
// ...
else if (exception.getMessage().equalsIgnoreCase("unusual location")) {
errorMessage = messages.getMessage("auth.message.unusual.location", null, locale);
}
}
现在,让我们深入了解一下isNewLoginLocation()的实现:
@Override
public NewLocationToken isNewLoginLocation(String username, String ip) {
try {
InetAddress ipAddress = InetAddress.getByName(ip);
String country = databaseReader.country(ipAddress).getCountry().getName();
User user = repository.findByEmail(username);
UserLocation loc = userLocationRepo.findByCountryAndUser(country, user);
if ((loc == null) || !loc.isEnabled()) {
return createNewLocationToken(country, user);
}
} catch (Exception e) {
return null;
}
return null;
}
请注意,当用户提供正确的凭据时,我们将如何检查他们的位置。如果该位置已与该用户帐户相关联,则用户能够成功进行身份验证。
如果不是,我们创建一个NewLocationToken和一个禁用的UserLocation-以允许用户启用这个新位置。有关更多信息,请参见以下部分。
private NewLocationToken createNewLocationToken(String country, User user) {
UserLocation loc = new UserLocation(country, user);
loc = userLocationRepo.save(loc);
NewLocationToken token = new NewLocationToken(UUID.randomUUID().toString(), loc);
return newLocationTokenRepository.save(token);
}
最后,这是简单的NewLocationToken实现-允许用户将新位置关联到他们的帐户:
@Entity
public class NewLocationToken {
@Id
@GeneratedValue(strategy = GenerationType.AUTO)
private Long id;
private String token;
@OneToOne(targetEntity = UserLocation.class, fetch = FetchType.EAGER)
@JoinColumn(nullable = false, name = "user_location_id")
private UserLocation userLocation;
// ...
}
5. 不同位置登录事件
当用户从不同的位置登录时,我们创建了一个NewLocationToken并使用它来触发OnDifferentLocationLoginEvent:
public class OnDifferentLocationLoginEvent extends ApplicationEvent {
private Locale locale;
private String username;
private String ip;
private NewLocationToken token;
private String appUrl;
}
DifferentLocationLoginListener按如下方式处理我们的事件:
@Component
public class DifferentLocationLoginListener implements ApplicationListener<OnDifferentLocationLoginEvent> {
@Autowired
private MessageSource messages;
@Autowired
private JavaMailSender mailSender;
@Autowired
private Environment env;
@Override
public void onApplicationEvent(OnDifferentLocationLoginEvent event) {
String enableLocUri = event.getAppUrl() + "/user/enableNewLoc?token=" + event.getToken().getToken();
String changePassUri = event.getAppUrl() + "/changePassword.html";
String recipientAddress = event.getUsername();
String subject = "Login attempt from different location";
String message = messages.getMessage("message.differentLocation", new Object[] {
new Date().toString(),
event.getToken().getUserLocation().getCountry(),
event.getIp(), enableLocUri, changePassUri
}, event.getLocale());
SimpleMailMessage email = new SimpleMailMessage();
email.setTo(recipientAddress);
email.setSubject(subject);
email.setText(message);
email.setFrom(env.getProperty("support.email"));
mailSender.send(email);
}
}
请注意,当用户从不同位置登录时,我们将如何发送电子邮件通知他们。
如果其他人试图登录他们的帐户,他们当然会更改密码。如果他们识别出身份验证尝试,他们将能够将新的登录位置关联到他们的帐户。
6. 启用新的登录位置
最后,既然用户已收到可疑活动的通知,让我们看看应用程序将如何处理启用新位置:
@RequestMapping(value = "/user/enableNewLoc", method = RequestMethod.GET)
public String enableNewLoc(Locale locale, Model model, @RequestParam("token") String token) {
String loc = userService.isValidNewLocationToken(token);
if (loc != null) {
model.addAttribute(
"message",
messages.getMessage("message.newLoc.enabled", new Object[] { loc }, locale)
);
} else {
model.addAttribute(
"message",
messages.getMessage("message.error", null, locale)
);
}
return "redirect:/login?lang=" + locale.getLanguage();
}
我们的isValidNewLocationToken()方法:
@Override
public String isValidNewLocationToken(String token) {
NewLocationToken locToken = newLocationTokenRepository.findByToken(token);
if (locToken == null) {
return null;
}
UserLocation userLoc = locToken.getUserLocation();
userLoc.setEnabled(true);
userLoc = userLocationRepo.save(userLoc);
newLocationTokenRepository.delete(locToken);
return userLoc.getCountry();
}
简而言之,我们将启用与令牌关联的UserLocation,然后删除令牌。
7. 限制
为了完成本文,我们需要提及上述实现的一个局限性。我们用来确定客户端IP的方法:
private final String getClientIP(HttpServletRequest request)
并不总是返回客户端的正确IP地址。如果Spring Boot应用部署在本地,则返回的IP地址为0.0.0.0(除非配置不同)。由于此地址不存在于MaxMind数据库中,因此无法注册和登录。如果客户端的IP地址不存在于数据库中,则会出现同样的问题。
8. 总结
在本教程中,我们重点介绍了一种强大的新机制来为我们的应用程序添加安全性-根据用户的位置限制意外的用户活动。
与往常一样,本教程的完整源代码可在GitHub上获得。