[Springboot] spring-security 적용기(2) - OAuth2 구글 소셜 로그인

이 글은 인프런 - 최주호 강사의 스프링부트 시큐리티 & JWT 강의의 내용을 포함하고 있습니다.

 

 

저번 포스팅에서는 spring-security를 사용하여, 일반 로그인 기능을 간단하게 알아보았습니다.

 

이번 포스팅에선, 저번 기능에 살을 덧붙여서 소셜로그인 기능을 구현해보도록 하겠습니다.(저번 포스팅 참고)

 

먼저 구글 창에 google api 콘솔을 입력해서 들어갑니다. 

 

다음, 아래그림처럼 보이는 곳의 아래방향 화살표를 클릭해 새프로젝트를 생성해줍니다!

만들기를 통해 생성한 뒤, 아래 그림처럼 생성한 프로젝트를 선택해줍니다.

다음 왼쪽의 OAuth 동의 화면 탭에서 User Type을 외부로 설정해줍니다. 

만들기를 누르면, 아래처럼 OAuth 동의 화면이 뜨는데, 애플리케이션 이름만 적어주고 하단의 저장을 눌러줍니다.

그리고 이제 왼쪽의 사용자 인증 정보 탭을 들어가서, 상단의 사용자 인증 정보 만들기를 클릭합니다.

애플리케이션 유형을 웹 애플리케이션으로 설정하고, 이름과 승인된 리디렉션 URI를 설정합니다.

여기서 주의할점이 리디렉션 URI 경로인데,

승인된 리디렉션URI에는 "http://localhost:8080/login/oauth2/code/google" 을 입력한다. (빨간색은 정해진 내용입니다)

스프링 부트 공식문서에 나와있는 내용입니다.

https://docs.spring.io/spring-security/reference/servlet/oauth2/login/core.html

그리고 만들기를 누르면 OAuth클라이언트가 생성됩니다!

 

다시 프로젝트로 돌아가서, pom.xml에 OAuth2 클라이언트 라이브러리를 추가해줍니다.

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-oauth2-client</artifactId>
</dependency>

그 다음, application.yml에서 아래를 추가해줍니다(spring하위로).

spring:
  security:
    oauth2:
      client:
        registration:
          google: 
            client-id: 발급받은 클라이언트ID
            client-secret: 발급받은 클라이언트 보안비밀 번호
            scope:
              - email
              - profile

여기까지 구글API와 연동이었고, 이제 버튼을 통해 기능 구현을 하도록 해보겠습니다.

 

Controller에 GetMapping으로 리디렉션 주소를 적어줄필요없음(OAuth2라이브러리가 알아서해줌, 대신 주소는 고정)

 

loginForm.html에 버튼 하나를 생성해주고(주의!! oauth2 client 라이브러리를 주입받았기 때문에, href 주소는 고정!)

<a href="/oauth2/authorization/google">구글 로그인</a>

 

그리고 SecurityConfig 클래스에 이렇게 수정해줍니다(일반로그인 설정부분에서 defaultSuccessUrl밑부터 추가했음)

지금 principalOauth2UserService 클래스(구글 로그인 후, 후처리를 담당하는 클래스)는 생성하지 않았으니 빨간줄이 떠도 무시합니다.

@Configuration
@EnableWebSecurity // 스프링 시큐리티 필터가 스프링 필터체인에 등록이 됨
@EnableGlobalMethodSecurity(securedEnabled = true, prePostEnabled = true) // secured 어노테이션 활성화, preAuthorize, postAuthorize 어노테이션 활성화
public class SecurityConfig {
	
    // @Autowired의 생성자 주입 방식
    private PrincipalOauth2UserService principalOauth2UserService;

    @Autowired
    public SecurityConfig(PrincipalOauth2UserService principalOauth2UserService) {
        this.principalOauth2UserService = principalOauth2UserService;
    }

    @Bean	
    public SecurityFilterChain filterChain(HttpSecurity http) throws Exception {
        http.csrf().disable();
        http.authorizeRequests()
                .antMatchers("/user/**").authenticated() // 인증만 되면 들어갈 수 있는 주소
                .antMatchers("/manager/**").access("hasAnyRole('ROLE_MANAGER','ROLE_ADMIN')")
                .antMatchers("/admin/**").access("hasRole('ROLE_ADMIN')")
                .anyRequest().permitAll()
                .and()
                .formLogin()
                .loginPage("/loginForm")
                .loginProcessingUrl("/login") // /login 주소가 호출이 되면 시큐리티가 낚아채서 대신 로그인을 진행해줌
                .defaultSuccessUrl("/")
                .and()
                .oauth2Login()
                .loginPage("/loginForm") 
                .userInfoEndpoint()		//oauth2Login에 성공하면 principalOauth2UserService에서 설정을 진행하겠다는 의미
                .userService(principalOauth2UserService); // 구글 로그인이 완료된 뒤의 후처리가 필요함. 1. 코드받기(인증), 2. 엑세스토큰, 3. 사용자프로필 정보를 가져오고 4. 그 정보를 토대로 회원가입을 자동으로 진행시키기도 함 
        return http.build();							  // Tip. 구글로그인이 완료되면 코드를 받는게 아닌, (엑세스토큰 + 사용자프로필정보를 받음)
    }
}

 

다음 IndexController의 @GetMapping("/user")부분을 아래와 같이 수정해줍니다.

@GetMapping("/user")
public @ResponseBody String user(@AuthenticationPrincipal PrincipalDetails principalDetails) {
    System.out.println("principalDetails : " + principalDetails.getUser());
    return "user";
}

 

이제 principalOauth2UserService 클래스를 생성합니다!

@Service
public class PrincipalOauth2UserService extends DefaultOAuth2UserService {
	
	private BCryptPasswordEncoder bCryptPasswordEncoder;
	
	@Autowired
	public PrincipalOauth2UserService(BCryptPasswordEncoder bCryptPasswordEncoder) {
		this.bCryptPasswordEncoder = bCryptPasswordEncoder;
	}
	
	@Autowired
	private UserRepository userRepository;
	
	// 구글로 부터 받은 userReuqest 데이터에 대한 후처리되는 함수
	// 함수 종료시 @AuthenticationPrincipal 어노테이션이 만들어진다.
	@Override
	public OAuth2User loadUser(OAuth2UserRequest userRequest) throws OAuth2AuthenticationException {
		System.out.println("getClientRegistration: " + userRequest.getClientRegistration()); // registrationId로 어떤 OAuth로 로그인 했는지 확인가능.
		System.out.println("getAccessToken: " + userRequest.getAccessToken().getTokenValue());
		
		OAuth2User oauth2User = super.loadUser(userRequest);
		// 구글로그인 버튼 클릭 -> 구글로그인창 -> 로그인을 완료 -> code를 리턴(OAuth-Client라이브러리) -> AccessToken요청
		// userRequest 정보 -> loadUser함수 호출 -> 구글로부터 회원프로필 받아준다.
		System.out.println("getAttributes: " + super.loadUser(userRequest).getAttributes());
		
		// 회원가입 진행
		OAuth2UserInfo oAuth2UserInfo = null;
		if(userRequest.getClientRegistration().getRegistrationId().equals("google")) {
			System.out.println("구글 로그인 요청");
			oAuth2UserInfo = new GoogleUserInfo(oauth2User.getAttributes());
		} else {
			System.out.println("우리는 구글만 지원해요 ㅎㅎㅎ");
		}
			
		String provider = oAuth2UserInfo.getProvider();
		String providerId = oAuth2UserInfo.getProviderId();
		String username = provider+"_"+providerId;  
		String password = bCryptPasswordEncoder.encode("겟인데어");
		String email = oAuth2UserInfo.getEmail();
		String role = "ROLE_USER";
		
		// 기존에 있는 회원이면 진행안하게 해야함
		User userEntity = userRepository.findByUsername(username);
		if(userEntity == null) {
			System.out.println("로그인이 최초입니다.");
			userEntity = User.builder()
					.username(username)
					.password(password)
					.email(email)
					.role(role)
					.provider(provider)
					.providerId(providerId)
					.build();
			userRepository.save(userEntity);
		} else {
			System.out.println("로그인을 이미 한적이 있습니다. 당신은 자동회원가입이 되어 있습니다.");
		}
		
		return new PrincipalDetails(userEntity, oauth2User.getAttributes());
	}
}

 

여기서 빨간표시가 뜨는 부분은 OAuth2UserInfo와 GoogleUserInfo, .builder()부분인데 하나씩 추가해보겠습니다!

먼저 .builder()를 해결하기 위해 User클래스를 들어갑니다. 그리고 아래와 같이 기존 User클래스를 수정합니다.

@Entity
@Data
@NoArgsConstructor //Default Constructor
public class User {
	
	@Id //primary key
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private int id;
	
	private String username;
	private String password;
	private String email;
	private String role; //ROLE_USER, ROLE_MANAGER, ROLE_ADMIN
	
	private String provider; // 소셜 로그인(Google, Naver, Facebook 등)
	private String providerId; 
	
	@CreationTimestamp
	private Timestamp createDate;

	@Builder
	public User(String username, String password, String email, String role, String provider, String providerId,
			Timestamp createDate) {
		this.username = username;
		this.password = password;
		this.email = email;
		this.role = role;
		this.provider = provider;
		this.providerId = providerId;
		this.createDate = createDate;
	}

}

 

다음 OAuth2UserInfo 인터페이스를 생성합니다.

public interface OAuth2UserInfo {
    String getProviderId();
    String getProvider();
    String getEmail();
    String getName();
}

 

그리고 구글에서 받아온 유저 정보를 담기 위한 GoogleUserInfo 클래스를 생성합니다(OAuth2UserInfo 인터페이스 구현).

public class GoogleUserInfo implements OAuth2UserInfo {
	
    private Map<String, Object> attributes; // getAttributes()

    public GoogleUserInfo(Map<String, Object> attributes) {
        this.attributes = attributes;
    }

    @Override
    public String getProviderId() {
        return (String) attributes.get("sub");
    }

    @Override
    public String getProvider() {
        return "google";
    }

    @Override
    public String getEmail() {
        return (String) attributes.get("email");
    }

    @Override
    public String getName() {
        return (String) attributes.get("name");
    }

}

여기까지 생성하고 구글로그인을 진행하면, 성공적으로 회원가입이 되면서 로그인되고 DB에도 값이 제대로 들어가는 걸 확인할 수 있습니다!