web-dev-qa-db-ja.com

Spring SecurityでJavaコードの「hasRole」を確認する方法

Java Codeのユーザー権限または許可を確認する方法たとえば、役割に応じてユーザーのボタンを表示または非表示にします。次のような注釈があります。

@PreAuthorize("hasRole('ROLE_USER')")

Javaコードで作成する方法は？何かのようなもの ：

if(somethingHere.hasRole("ROLE_MANAGER")) {
   layout.addComponent(new Button("Edit users"));
}
javaspring-securityuser-roles
111
Piotr Gwiazda

Spring Security 3.0にはこのAPIがあります

SecurityContextHolderAwareRequestWrapper.isUserInRole(String role)

使用する前にラッパーを挿入する必要があります。

SecurityContextHolderAwareRequestWrapper

67
JoseK

httpServletRequestオブジェクトのisUserInRoleメソッドを使用できます。

何かのようなもの：

public String createForm(HttpSession session, HttpServletRequest request,  ModelMap   modelMap) {


    if (request.isUserInRole("ROLE_ADMIN")) {
        // code here
    }
}
132
gouki

ループを使用してUserDetailsから機関を検索する代わりに、次のことができます。

Collection<? extends GrantedAuthority> authorities = authentication.getAuthorities();
boolean authorized = authorities.contains(new SimpleGrantedAuthority("ROLE_ADMIN"));
61
Ninca

セキュリティコンテキストを取得して、それを使用できます。

    import org.springframework.security.core.Authentication;
    import org.springframework.security.core.GrantedAuthority;
    import org.springframework.security.core.context.SecurityContext;
    import org.springframework.security.core.context.SecurityContextHolder;

    protected boolean hasRole(String role) {
        // get security context from thread local
        SecurityContext context = SecurityContextHolder.getContext();
        if (context == null)
            return false;

        Authentication authentication = context.getAuthentication();
        if (authentication == null)
            return false;

        for (GrantedAuthority auth : authentication.getAuthorities()) {
            if (role.equals(auth.getAuthority()))
                return true;
        }

        return false;
    }
46
Nate Sammons

以下のようにhasRole（）メソッドを実装できます-（これは、スプリングセキュリティ3.0.xでテストされており、他のバージョンについては確認されていません。）

  protected final boolean hasRole(String role) {
    boolean hasRole = false;
    UserDetails userDetails = getUserDetails();
    if (userDetails != null) {
      Collection<GrantedAuthority> authorities = userDetails.getAuthorities();
      if (isRolePresent(authorities, role)) {
        hasRole = true;
      }
    } 
    return hasRole;
  }
  /**
   * Get info about currently logged in user
   * @return UserDetails if found in the context, null otherwise
   */
  protected UserDetails getUserDetails() {
    Object principal = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
    UserDetails userDetails = null;
    if (principal instanceof UserDetails) {
      userDetails = (UserDetails) principal;
    }
    return userDetails;
  }
  /**
   * Check if a role is present in the authorities of current user
   * @param authorities all authorities assigned to current user
   * @param role required authority
   * @return true if role is present in list of authorities assigned to current user, false otherwise
   */
  private boolean isRolePresent(Collection<GrantedAuthority> authorities, String role) {
    boolean isRolePresent = false;
    for (GrantedAuthority grantedAuthority : authorities) {
      isRolePresent = grantedAuthority.getAuthority().equals(role);
      if (isRolePresent) break;
    }
    return isRolePresent;
  }
14
Gopi

私はこれを使用しています：

@RequestMapping(method = RequestMethod.GET)
public void welcome(SecurityContextHolderAwareRequestWrapper request) {
    boolean b = request.isUserInRole("ROLE_ADMIN");
    System.out.println("ROLE_ADMIN=" + b);

    boolean c = request.isUserInRole("ROLE_USER");
    System.out.println("ROLE_USER=" + c);
}
10
Joey Jarin

AuthorityUtils classからヘルプを入手できます。ワンライナーとしての役割の確認：

if (AuthorityUtils.authorityListToSet(SecurityContextHolder.getContext().getAuthentication().getAuthorities()).contains("ROLE_MANAGER")) {
    /* ... */
}

警告：ロール階層が存在する場合、これはチェックしません。

7
holmis83

JoseKからの回答は、HTTPリクエストへの参照からWebレイヤーとのカップリングを導入したくないサービスレイヤーでは使用できません。サービス層で役割を解決することを検討している場合、Gopiの答えが道です。

ただし、少し長くかかっています。権限には、認証から直接アクセスできます。したがって、ユーザーがログインしていると想定できる場合、次のようにします。

/**
 * @return true if the user has one of the specified roles.
 */
protected boolean hasRole(String[] roles) {
    boolean result = false;
    for (GrantedAuthority authority : SecurityContextHolder.getContext().getAuthentication().getAuthorities()) {
        String userRole = authority.getAuthority();
        for (String role : roles) {
            if (role.equals(userRole)) {
                result = true;
                break;
            }
        }

        if (result) {
            break;
        }
    }

    return result;
}
5
Starman

ほとんどの答えにはいくつかの点が欠けています。

  1. 役割と権限は、Springでは同じものではありません。 more の詳細については、こちらをご覧ください。

  2. ロール名はrolePrefix + authorityと等しくなります。

  3. デフォルトのロール接頭辞はROLE_ですが、構成可能です。 here を参照してください。

したがって、適切なロールチェックでは、ロールプレフィックスが設定されている場合はそれを尊重する必要があります。

残念ながら、Springでのロールプレフィックスのカスタマイズは少しハックが多く、多くの場所でデフォルトプレフィックスROLE_がハードコードされていますが、それに加えて、SpringコンテキストでGrantedAuthorityDefaults型のBeanがチェックされます。存在する場合は、そのカスタムロールプレフィックスが尊重されます。

これらすべての情報をまとめると、ロールチェッカーの実装は次のようになります。

@Component
public class RoleChecker {

    @Autowired(required = false)
    private GrantedAuthorityDefaults grantedAuthorityDefaults;

    public boolean hasRole(String role) {
        String rolePrefix = grantedAuthorityDefaults != null ? grantedAuthorityDefaults.getRolePrefix() : "ROLE_";
        return Optional.ofNullable(SecurityContextHolder.getContext().getAuthentication())
                .map(Authentication::getAuthorities)
                .map(Collection::stream)
                .orElse(Stream.empty())
                .map(GrantedAuthority::getAuthority)
                .map(authority -> rolePrefix + authority)
                .anyMatch(role::equals);
    }
}
4
Utku Özdemir

不思議なことに、スプリングセキュリティアクセス制御はJavaベースではなく 式ベース であるため、この問題に対する標準的な解決策はないと思います。 DefaultMethodSecurityExpressionHandler のソースコードをチェックして、そこで行っていることを再利用できるかどうかを確認できます。

2
Sean Patrick Floyd

@goukiの答えが最高です！

春がこれを実際に行う方法のほんの一例です。

SecurityContextHolderAwareRequestWrapperクラスを実装するServletRequestWrapperという名前のクラスがあります。

SecurityContextHolderAwareRequestWrapperはisUserInRoleをオーバーライドし、ユーザーAuthentication（Springが管理）を検索して、ユーザーがロールを持っているかどうかを確認します。

SecurityContextHolderAwareRequestWrapperコードは次のとおりです。

    @Override
    public boolean isUserInRole(String role) {
        return isGranted(role);
    }

 private boolean isGranted(String role) {
        Authentication auth = getAuthentication();

        if( rolePrefix != null ) {
            role = rolePrefix + role;
        }

        if ((auth == null) || (auth.getPrincipal() == null)) {
            return false;
        }

        Collection<? extends GrantedAuthority> authorities = auth.getAuthorities();

        if (authorities == null) {
            return false;
        }

        //This is the loop which do actual search
        for (GrantedAuthority grantedAuthority : authorities) {
            if (role.equals(grantedAuthority.getAuthority())) {
                return true;
            }
        }

        return false;
    }
2
Alireza Fattahi

以下のこの2つの注釈は同じです。「hasRole」はプレフィックス「ROLE_」を自動的に追加します。正しい注釈があることを確認してください。この役割は、UserDetailsS​​ervice＃loadUserByUsernameで設定されます。

@PreAuthorize("hasAuthority('ROLE_user')")
@PreAuthorize("hasRole('user')")

その後、Javaコードでロールを取得できます。

Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
if(authentication.getAuthorities().contains(new SimpleGrantedAuthority("ROLE_user"))){
    System.out.println("user role2");
}
2
Luke Cheung

遅くなることはありませんが、2セントの価値を持たせてください。

JSFの世界では、マネージドBean内で次のことを行いました。


HttpServletRequest req = (HttpServletRequest) FacesContext.getCurrentInstance().getExternalContext().getRequest();
SecurityContextHolderAwareRequestWrapper sc = new SecurityContextHolderAwareRequestWrapper(req, "");

上記のように、私の理解では、次のように長い方法で行うことができます：


Object principal = SecurityContextHolder.getContext().getAuthentication().getPrincipal();
UserDetails userDetails = null;
if (principal instanceof UserDetails) {
    userDetails = (UserDetails) principal;
    Collection  authorities = userDetails.getAuthorities();
}
2
lukec

これはもう一方の端からの質問に来ているようなものですが、これを見つけるためにインターネットで本当に掘り下げなければならなかったので、私はそれを投げ込むと思いました。

ロールをチェックする方法についてはたくさんありますが、hasRole（ "blah"）と言ったときに実際にチェックしていることはあまり言いません。

HasRoleは、現在認証されているプリンシパルの付与された権限をチェックします

hasRole（ "blah"）は本当にhasAuthority（ "blah"）を意味します。

私が見たケースでは、getAuthoritiesと呼ばれるメソッドを定義するUserDetailsを実装するクラスでこれを行います。これでは、基本的に、いくつかのロジックに基づいていくつかのnew SimpleGrantedAuthority("some name")をリストに追加します。このリストの名前は、hasRoleステートメントによってチェックされるものです。

このコンテキストでは、UserDetailsオブジェクトが現在認証されているプリンシパルだと思います。認証プロバイダーとその周辺で発生する魔法があり、具体的にはこれを実現する認証マネージャーがあります。

1
JonnyRaa

私たちのプロジェクトでは、ロール階層を使用していますが、上記の回答のほとんどは特定のロールの確認のみを目的としています。つまり、指定されたロールのみを確認し、そのロールと階層の上位は確認しません。

これに対する解決策：

@Component
public class SpringRoleEvaluator {

@Resource(name="roleHierarchy")
private RoleHierarchy roleHierarchy;

public boolean hasRole(String role) {
    UserDetails dt = AuthenticationUtils.getSessionUserDetails();

    for (GrantedAuthority auth: roleHierarchy.getReachableGrantedAuthorities(dt.getAuthorities())) {
        if (auth.toString().equals("ROLE_"+role)) {
            return true;
        }
    }
    return false;
}

RoleHierarchyは、spring-security.xmlでBeanとして定義されます。

1
Kirinya

ユーザーモデルに、以下のような「hasRole」メソッドを追加するだけです

public boolean hasRole(String auth) {
    for (Role role : roles) {
        if (role.getName().equals(auth)) { return true; }
    }
    return false;
}

私は通常、認証されたユーザーが次のようにロール管理者を持っているかどうかを確認するために使用します

Authentication authentication = SecurityContextHolder.getContext().getAuthentication(); // This gets the authentication
User authUser = (User) authentication.getPrincipal(); // This gets the logged in user
authUser.hasRole("ROLE_ADMIN") // This returns true or false
0
user8174892

Java 8の助けを借りた私のアプローチ、コンマ区切りのロールを渡すとtrueまたはfalseが得られます

    public static Boolean hasAnyPermission(String permissions){
    Boolean result = false;
    if(permissions != null && !permissions.isEmpty()){
        String[] rolesArray = permissions.split(",");
        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
        for (String role : rolesArray) {
            boolean hasUserRole = authentication.getAuthorities().stream().anyMatch(r -> r.getAuthority().equals(role));
            if (hasUserRole) {
                result = true;
                break;
            }
        }
    }
    return result;
}
0
Jajikanth pydimarla