web-dev-qa-db-ja.com

Spring Securityを使用する場合、Beanの現在のユーザー名（つまりSecurityContext）情報を取得する適切な方法は何ですか？

Spring Securityを使用するSpring MVC Webアプリがあります。現在ログインしているユーザーのユーザー名を知りたい。以下のコードスニペットを使用しています。これは受け入れられた方法ですか？

私はこのコントローラー内で静的メソッドを呼び出すのが好きではありません。これは、Spring、IMHOの目的全体を無効にします。代わりに、現在のSecurityContextまたは現在の認証を挿入するようにアプリを構成する方法はありますか？

  @RequestMapping(method = RequestMethod.GET)
  public ModelAndView showResults(final HttpServletRequest request...) {
    final String currentUser = SecurityContextHolder.getContext().getAuthentication().getName();
    ...
  }
javaspringspring-mvcspring-security
272
Scott Bale

Spring を使用している場合、最も簡単な方法は次のとおりです。

 @RequestMapping(method = RequestMethod.GET)   
 public ModelAndView showResults(final HttpServletRequest request, Principal principal) {

     final String currentUser = principal.getName();

 }
245
tsunade21

この質問に答えられてから、春の世界では多くのことが変わりました。 Springは、現在のユーザーをコントローラーで取得することを簡素化しました。他のBeanについては、Springは著者の提案を採用し、「SecurityContextHolder」の挿入を簡素化しました。詳細はコメントにあります。

これが私が最終的に解決したソリューションです。コントローラでSecurityContextHolderを使用する代わりに、フードの下でSecurityContextHolderを使用するが、コードからそのシングルトンのようなクラスを抽象化するものを注入したいと思います。次のように、独自のインターフェイスをローリングする以外にこれを行う方法は見つかりませんでした：

public interface SecurityContextFacade {

  SecurityContext getContext();

  void setContext(SecurityContext securityContext);

}

これで、私のコントローラー（またはPOJOは何でも）は次のようになります。

public class FooController {

  private final SecurityContextFacade securityContextFacade;

  public FooController(SecurityContextFacade securityContextFacade) {
    this.securityContextFacade = securityContextFacade;
  }

  public void doSomething(){
    SecurityContext context = securityContextFacade.getContext();
    // do something w/ context
  }

}

また、インターフェースがデカップリングのポイントであるため、ユニットテストは簡単です。この例では、Mockitoを使用します。

public class FooControllerTest {

  private FooController controller;
  private SecurityContextFacade mockSecurityContextFacade;
  private SecurityContext mockSecurityContext;

  @Before
  public void setUp() throws Exception {
    mockSecurityContextFacade = mock(SecurityContextFacade.class);
    mockSecurityContext = mock(SecurityContext.class);
    stub(mockSecurityContextFacade.getContext()).toReturn(mockSecurityContext);
    controller = new FooController(mockSecurityContextFacade);
  }

  @Test
  public void testDoSomething() {
    controller.doSomething();
    verify(mockSecurityContextFacade).getContext();
  }

}

インターフェイスのデフォルトの実装は次のようになります。

public class SecurityContextHolderFacade implements SecurityContextFacade {

  public SecurityContext getContext() {
    return SecurityContextHolder.getContext();
  }

  public void setContext(SecurityContext securityContext) {
    SecurityContextHolder.setContext(securityContext);
  }

}

そして、最後に、実稼働のSpring構成は次のようになります。

<bean id="myController" class="com.foo.FooController">
     ...
  <constructor-arg index="1">
    <bean class="com.foo.SecurityContextHolderFacade">
  </constructor-arg>
</bean>

すべてのものの依存関係注入コンテナーであるSpringが、類似のものを注入する方法を提供していないことは、少しばかげているように思えます。 SecurityContextHolderはacegiから継承されたと理解していますが、それでもです。重要なのは、それらが非常に近いことです。SecurityContextHolderだけが、基になるSecurityContextHolderStrategyインスタンス（インターフェース）を取得するゲッターを持っている場合、それを注入できます。実際、私は Jiraの問題を開いた でさえその効果を発揮しています。

最後に、ここでの答えを大幅に変更しました。興味がある場合は履歴を確認してください。しかし、同僚が私に指摘したように、私の以前の答えはマルチスレッド環境では機能しません。 SecurityContextHolderStrategyで使用される基になるSecurityContextHolderは、デフォルトではThreadLocalSecurityContextHolderStrategyのインスタンスであり、SecurityContextsをThreadLocalに格納します。したがって、初期化時にSecurityContextをBeanに直接注入することは必ずしも良い考えではありません。マルチスレッド環境では毎回ThreadLocalから取得する必要があるため、正しいスレッドが取得されます。

58
Scott Bale

JSPページに表示されるようにするには、Spring Security Tag Libを使用できます。

http://static.springsource.org/spring-security/site/docs/3.0.x/reference/taglibs.html

タグを使用するには、JSPでセキュリティtaglibを宣言する必要があります。

<%@ taglib prefix="security" uri="http://www.springframework.org/security/tags" %>

次に、jspページで次のようなことを行います。

<security:authorize access="isAuthenticated()">
    logged in as <security:authentication property="principal.username" /> 
</security:authorize>

<security:authorize access="! isAuthenticated()">
    not logged in
</security:authorize>

注：@ SBerg413によるコメントで述べたように、追加する必要があります。

use-expressions = "true"

これが機能するように、security.xml構成の「http」タグに追加します。

21
Brad Parks

現在のユーザーのSecurityContextをクエリする必要があることに同意しますが、この問題を処理するのは非常に非春の方法のようです。

この問題に対処するために、静的な「ヘルパー」クラスを作成しました。グローバルで静的なメソッドであるという点で汚いですが、セキュリティに関連する何かを変更した場合、少なくとも1か所で詳細を変更するだけでよいのです。

/**
* Returns the domain User object for the currently logged in user, or null
* if no User is logged in.
* 
* @return User object for the currently logged in user, or null if no User
*         is logged in.
*/
public static User getCurrentUser() {

    Object principal = SecurityContextHolder.getContext().getAuthentication().getPrincipal()

    if (principal instanceof MyUserDetails) return ((MyUserDetails) principal).getUser();

    // principal object is either null or represents anonymous user -
    // neither of which our domain User object can represent - so return null
    return null;
}


/**
 * Utility method to determine if the current user is logged in /
 * authenticated.
 * <p>
 * Equivalent of calling:
 * <p>
 * <code>getCurrentUser() != null</code>
 * 
 * @return if user is logged in
 */
public static boolean isLoggedIn() {
    return getCurrentUser() != null;
}
21
matt b

Spring Securityバージョン3.2以降を使用している場合は、@AuthenticationPrincipalアノテーションを使用できます。

@RequestMapping(method = RequestMethod.GET)
public ModelAndView showResults(@AuthenticationPrincipal CustomUser currentUser, HttpServletRequest request) {
    String currentUsername = currentUser.getUsername();
    // ...
}

ここで、CustomUserは、カスタムUserDetailsによって返されるUserDetailsServiceを実装するカスタムオブジェクトです。

詳細については、Spring Securityリファレンスドキュメントの @ AuthenticationPrincipal の章を参照してください。

14
matsev

HttpServletRequest.getUserPrincipal（）で認証済みユーザーを取得します。

例：

import javax.servlet.http.HttpServletRequest;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.web.authentication.preauth.RequestHeaderAuthenticationFilter;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.support.RequestContext;

import foo.Form;

@Controller
@RequestMapping(value="/welcome")
public class IndexController {

    @RequestMapping(method=RequestMethod.GET)
    public String getCreateForm(Model model, HttpServletRequest request) {

        if(request.getUserPrincipal() != null) {
            String loginName = request.getUserPrincipal().getName();
            System.out.println("loginName : " + loginName );
        }

        model.addAttribute("form", new Form());
        return "welcome";
    }
}
13
digz6666

Spring 3以降では、次のオプションがあります。

オプション1 ：

@RequestMapping(method = RequestMethod.GET)    
public String currentUserNameByPrincipal(Principal principal) {
    return principal.getName();
}

オプション2：

@RequestMapping(method = RequestMethod.GET)
public String currentUserNameByAuthentication(Authentication authentication) {
    return authentication.getName();
}

オプション3：

@RequestMapping(method = RequestMethod.GET)    
public String currentUserByHTTPRequest(HttpServletRequest request) {
    return request.getUserPrincipal().getName();

}

オプション4：ファンシー1： 詳細はこちらをご覧ください

public ModelAndView someRequestHandler(@ActiveUser User activeUser) {
  ...
}
8
Farm

はい、静的は一般に悪いです-一般に、しかし、この場合、静的はあなたが書くことができる最も安全なコードです。セキュリティコンテキストはプリンシパルを現在実行中のスレッドに関連付けるため、最も安全なコードは、可能な限り直接スレッドから静的にアクセスします。挿入されたラッパークラスの背後にアクセスを隠すと、攻撃者は攻撃するポイントが増えます。コードにアクセスする必要はなく（jarが署名されている場合は変更に苦労します）、構成をオーバーライドする方法が必要です。これは、実行時に行うか、XMLをクラスパスにスリップすることができます。署名されたコードでアノテーションインジェクションを使用しても、外部XMLでオーバーライドできます。このようなXMLは、実行中のシステムに不正なプリンシパルを挿入する可能性があります。これがおそらく、Springがこの場合、Springに似ていない何かをしている理由です。

5
Michael Bushe

私はこれをするだけです：

request.getRemoteUser();
5
Dan

私が書いた最後のSpring MVCアプリでは、SecurityContextホルダーを挿入しませんでしたが、これに関連する2つのユーティリティメソッドを持つベースコントローラーがありました... isAuthenticated（）＆getUsername（）。内部的には、あなたが説明した静的メソッド呼び出しを行います。

少なくとも、後でリファクタリングする必要がある場合は、一度だけです。

4
RichH

Spring AOPアプローチを使用できます。たとえば、何らかのサービスがある場合、現在のプリンシパルを知る必要があります。カスタムアノテーション、つまり@Principalを導入できます。これは、このサービスがプリンシパルに依存する必要があることを示します。

public class SomeService {
    private String principal;
    @Principal
    public setPrincipal(String principal){
        this.principal=principal;
    }
}

次に、MethodBeforeAdviceを拡張する必要があると思うアドバイスで、特定のサービスに@Principalアノテーションがあり、プリンシパル名を挿入することを確認するか、代わりに「ANONYMOUS」に設定します。

3
Pavel Rodionov

唯一の問題は、Spring Securityで認証した後でも、ユーザー/プリンシパルBeanがコンテナに存在しないため、依存関係を注入することが難しいことです。 Spring Securityを使用する前に、現在のプリンシパルを持つセッションスコープのBeanを作成し、それを「AuthService」に注入してから、そのサービスをアプリケーション内の他のほとんどのサービスに注入します。したがって、これらのサービスは単にauthService.getCurrentUser（）を呼び出してオブジェクトを取得します。セッション内で同じプリンシパルへの参照を取得する場所がコードにある場合は、セッションスコープBeanのプロパティとして単純に設定できます。

2
cliff.meyers

@AuthenticationPrincipal注釈付きクラスだけでなく@Controllerクラスでも@ControllerAdvicer注釈を使用しています。例：

@ControllerAdvice
public class ControllerAdvicer
{
    private static final Logger LOGGER = LoggerFactory.getLogger(ControllerAdvicer.class);


    @ModelAttribute("userActive")
    public UserActive currentUser(@AuthenticationPrincipal UserActive currentUser)
    {
        return currentUser;
    }
}

ここで、UserActiveは、ログインユーザーサービスに使用するクラスであり、org.springframework.security.core.userdetails.Userから拡張されています。何かのようなもの：

public class UserActive extends org.springframework.security.core.userdetails.User
{

    private final User user;

    public UserActive(User user)
    {
        super(user.getUsername(), user.getPasswordHash(), user.getGrantedAuthorities());
        this.user = user;
    }

     //More functions
}

本当に簡単です。

1
EliuX

Spring 3を使用していて、コントローラーで認証済みのプリンシパルが必要な場合の最適なソリューションは、次のようなことです。

import org.springframework.security.authentication.UsernamePasswordAuthenticationToken;
import org.springframework.security.core.userdetails.User;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;

    @Controller
    public class KnoteController {
        @RequestMapping(method = RequestMethod.GET)
        public Java.lang.String list(Model uiModel, UsernamePasswordAuthenticationToken authToken) {

            if (authToken instanceof UsernamePasswordAuthenticationToken) {
                user = (User) authToken.getPrincipal();
            }
            ...

    }
1
Mark

これを試して

認証認証= SecurityContextHolder.getContext（）。getAuthentication（）;
String userName = authentication.getName（）;

1
cherit

Principalをコントローラーメソッドの依存関係として定義すると、springは呼び出し時にメソッドに現在の認証済みユーザーを挿入します。

0
Imrank