spring security oauth2 github 自定义用户

骑猪看日落 2023-03-13 12:20 33阅读 0赞

--------------------

### spring security oauth2 github 自定义用户 ###

**默认使用的用户类型为DefaultOAuth2User，可根据需求自定义用户类型**

## ##

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**相关类及接口**

**OAuth2User**

public interface OAuth2User extends OAuth2AuthenticatedPrincipal {
    
    }

**OAuth2AuthenticatedPrincipal**

public interface OAuth2AuthenticatedPrincipal extends AuthenticatedPrincipal {
        @Nullable
        default <A> A getAttribute(String name) {
            return this.getAttributes().get(name);
        }
    
        Map<String, Object> getAttributes();
    
        Collection<? extends GrantedAuthority> getAuthorities();
    }

**AuthenticatedPrincipal**

public interface AuthenticatedPrincipal {
        String getName();
    }

**DefaultOAuth2User**

public class DefaultOAuth2User implements OAuth2User, Serializable {
        private static final long serialVersionUID = 520L;
        private final Set<GrantedAuthority> authorities;
        private final Map<String, Object> attributes;
        private final String nameAttributeKey;
    
        public DefaultOAuth2User(Collection<? extends GrantedAuthority> authorities, Map<String, Object> attributes, String nameAttributeKey) {
            Assert.notEmpty(authorities, "authorities cannot be empty");
            Assert.notEmpty(attributes, "attributes cannot be empty");
            Assert.hasText(nameAttributeKey, "nameAttributeKey cannot be empty");
            if (!attributes.containsKey(nameAttributeKey)) {
                throw new IllegalArgumentException("Missing attribute '" + nameAttributeKey + "' in attributes");
            } else {
                this.authorities = Collections.unmodifiableSet(new LinkedHashSet(this.sortAuthorities(authorities)));
                this.attributes = Collections.unmodifiableMap(new LinkedHashMap(attributes));
                this.nameAttributeKey = nameAttributeKey;
            }
        }
    
        public String getName() {
            return this.getAttribute(this.nameAttributeKey).toString();
        }
    
        public Collection<? extends GrantedAuthority> getAuthorities() {
        public Map<String, Object> getAttributes() {
        private Set<GrantedAuthority> sortAuthorities(Collection<? extends GrantedAuthority> authorities) {
    
        public boolean equals(Object obj) {
        public int hashCode() {
    
        public String toString() {
            StringBuilder sb = new StringBuilder();
            sb.append("Name: [");
            sb.append(this.getName());
            sb.append("], Granted Authorities: [");
            sb.append(this.getAuthorities());
            sb.append("], User Attributes: [");
            sb.append(this.getAttributes());
            sb.append("]");
            return sb.toString();
        }
    }

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**示例**

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**配置文件**

**application.yml**

spring:
      security:
        oauth2:
          client:
            registration:
              github:
                client-id: ******
                client-secret: ******

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**pojo 层**

**GithubOAuth2User**

public class GithubOAuth2User implements OAuth2User {
    
        private String id;
        private String login;
        private String email;
    
        private List<GrantedAuthority> authorities= AuthorityUtils.createAuthorityList("ROLE_USER");
        private Map<String,Object> attributes;
    
        @Override
        public List<GrantedAuthority> getAuthorities() {
            return authorities;
        }
    
        @Override
        public Map<String, Object> getAttributes() {
            if (attributes==null){
                attributes=new HashMap<>();
    
                attributes.put("id",this.getId());
                attributes.put("name",this.getName());
                attributes.put("login",this.getLogin());
                attributes.put("email",this.getEmail());
            }
    
            return attributes;
        }
    
        public String getId() {
            return id;
        }
    
        public void setId(String id) {
            this.id = id;
        }
    
        @Override
        public String getName() {
            return this.id;
        }
    
        public String getLogin() {
            return login;
        }
    
        public void setLogin(String login) {
            this.login = login;
        }
    
        public String getEmail() {
            return email;
        }
    
        public void setEmail(String email) {
            this.email = email;
        }
    
        @Override
        public boolean equals(Object o) {
            if (this == o) return true;
            if (!(o instanceof GithubOAuth2User)) return false;
            GithubOAuth2User that = (GithubOAuth2User) o;
            return Objects.equals(getId(), that.getId()) &&
                    Objects.equals(getName(), that.getName()) &&
                    Objects.equals(getLogin(), that.getLogin()) &&
                    Objects.equals(getEmail(), that.getEmail()) &&
                    Objects.equals(getAuthorities(), that.getAuthorities()) &&
                    Objects.equals(getAttributes(), that.getAttributes());
        }
    
        @Override
        public int hashCode() {
            return Objects.hash(getId(), getName(), getLogin(), getEmail(), getAuthorities(), getAttributes());
        }
    
        @Override
        public String toString() {
            return "GithubOAuth2User{" +
                    "id='" + id + '\'' +
                    ", login='" + login + '\'' +
                    ", email='" + email + '\'' +
                    ", authorities=" + authorities +
                    ", attributes=" + attributes +
                    '}';
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**service 层**

**UserService**

@Service
    public class UserService implements UserDetailsService {
     
        @Resource
        private PasswordEncoder passwordEncoder;
     
        @Override
        public UserDetails loadUserByUsername(String s) throws UsernameNotFoundException {
            String name="gtlx";
            String password=passwordEncoder.encode("123456");
     
            List<GrantedAuthority> authorities=new ArrayList<>();
            authorities.add(new SimpleGrantedAuthority("ROLE_USER"));
     
            return new User(name,password,authorities);
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**config 层**

**WebConfig**

@Configuration
    public class WebConfig implements WebMvcConfigurer {
     
        @Override
        public void addViewControllers(ViewControllerRegistry registry) {
            registry.addViewController("/login/github").setViewName("login");
        }
    }

**WebSecurityConfig：****在该配置类中注册自定义的用户类**

@Configuration
    public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
    
        @Resource
        private UserService userService;
    
        @Bean
        public PasswordEncoder initPasswordEncoder(){
            return new BCryptPasswordEncoder();
        }
    
        @Override
        protected void configure(HttpSecurity http) throws Exception {
            http.formLogin().loginPage("/login/github").loginProcessingUrl("/login/form")
                    .and()
                    .authorizeRequests()
                    .antMatchers("/hello").hasAnyAuthority("ROLE_USER")
                    .antMatchers("/**").permitAll()
                    .and()
                    .logout().deleteCookies("JSESSIONID")
                    .logoutSuccessUrl("/").permitAll();
    
            http.oauth2Login().loginPage("/login/github")
                    .userInfoEndpoint().customUserType(GithubOAuth2User.class,"github");
                                        //在userInfoEndPoint端点处注册自定义的用户类GithubOAuth2User
    
        }
    
        @Override
        protected void configure(AuthenticationManagerBuilder auth) throws Exception {
            auth.userDetailsService(userService).passwordEncoder(initPasswordEncoder());
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**controller 层**

**HelloController**

@RestController
    public class HelloController {
    
        @RequestMapping("/hello")
        public String hello(Principal principal){
            System.out.println(principal.toString());
    
            return "hello "+principal.getName();
        }
    
        @RequestMapping("/")
        public String redirect(){
            return "redirect";
        }
    }

**\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\***

**前端页面**

**login.html**

<!DOCTYPE html>h
    <html lang="en" xmlns="http://www.w3.org/1999/xhtml"
          xmlns:th="http://www.thymeleaf.org" xmlns:sec="https://www.thymeleaf.org/thymeleaf-extras-springsecurity4">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
    <form th:action="@{/login/form}" th:align="center" method="post">
        username:<input th:type="text" name="username"><br>
        password:<input th:type="text" name="password"><br>
        <button>提交</button>
    </form>
     
    <div th:align="center">
        <a th:href="@{/oauth2/authorization/github}">github</a>
    </div>
    </body>
    </html>

### \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* ###

**使用测试**

**localhost:8080/hello**

![20200514170433354.png][]

**使用github授权登陆**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70][]

**控制台输出**

org.springframework.security.oauth2.client.authentication.OAuth2AuthenticationToken@1bfc5d6d: 
    Principal: GithubOAuth2User{id='41827785', login='lihu12344', email='null', authorities=[ROLE_USER], attributes={name=41827785, id=41827785, login=lihu12344, email=null}}; 
    Credentials: [PROTECTED]; 
    Authenticated: true; 
    Details: org.springframework.security.web.authentication.WebAuthenticationDetails@21a2c: 
    RemoteIpAddress: 0:0:0:0:0:0:0:1; SessionId: 270B5EFC536F9356F5A102305C1D8B97; Granted 
    Authorities: ROLE_USER

**github客户端使用的是自定义用户类GithubOAuth2User**

[20200514170433354.png]: /images/20230312/488fa2e179ff473aaf63f5f86d688d62.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzMTYyNQ_size_16_color_FFFFFF_t_70]: /images/20230312/f89662b60765477c9d996093a0bc91e8.png