セキュリティ

spring_boot_starter_security がある場合、Actuator のエンドポイントは他のリクエストと同じくセキュリティフィルターチェーンを通ります。EndpointRequest はパスを繰り返さずにそれらに一致し、show-details=when-authorized はロールを持つユーザーにだけヘルスの詳細を示します。

使う理由

health はロードバランサーと Kubernetes のために開いておかなければなりませんが、mappings や独自のエンドポイントはそうすべきではありません。エンドポイントをパスではなく ID で照合すれば、management.endpoints.web.base-path やパスのマッピングが変わってもルールは正しいままです。

例

@Configuration()
class ActuatorSecurity {
  // Actuator 専用のチェーン: health と info は公開、それ以外は管理者向け。
  @Bean()
  @Order(1)
  SecurityFilterChain actuator(HttpSecurity http) => http
      .securityMatcherOf(EndpointRequest.toAnyEndpoint())
      .authorizeHttpRequests((auth) => auth
          .requestMatchersOf([EndpointRequest.to(['health', 'info'])])
          .permitAll()
          .anyRequest()
          .hasRole('ADMIN'))
      .httpBasic()
      .build();
}
# lib/resources/application.yml
management:
  endpoints:
    web:
      exposure:
        include: "*"
  endpoint:
    health:
      show-details: when-authorized
      roles: ADMIN
$ curl localhost:8080/actuator/health
{"status":"UP"}
$ curl -u admin:secret localhost:8080/actuator/health
{"status":"UP","components":{"diskSpace":{"status":"UP","details":{...}},"ping":{"status":"UP"}}}

EndpointRequest

マッチャー 一致するもの
EndpointRequest.toAnyEndpoint() 公開されたすべてのエンドポイントと、ディスカバリーページ
EndpointRequest.to(['health', 'info']) ID で指定したそれらのエンドポイント
EndpointRequest.toAnyEndpoint().excluding(['health']) それら以外のすべてのエンドポイント
EndpointRequest.toAnyEndpoint().excludingLinks() ディスカバリーページを除くすべてのエンドポイント
EndpointRequest.toLinks() ディスカバリーページのみ

EndpointRequest はセキュリティスターターにあります。独自のパスパターンではなく、Actuator の Web 層が記録したリクエスト (webEndpointRequestFilter が設定するリクエスト属性) に一致するため、ベースパスとパスのマッピングに従います。公開されたエンドポイントでないパス (env が公開されていないときの /actuator/env) は何にも一致せず、他のマッチャーのルールが適用されます。

when-authorized

management.endpoint.health.show-details=when-authorized (と show-components、そしてグループの同じキー) は、management.endpoint.health.roles のいずれかを持つログイン済みのユーザーに、ロールが設定されていなければログイン済みの任意のユーザーに詳細を示します。ロールはリクエストの Authentication から読まれます: ROLE_ADMIN はロール ADMIN です。セキュリティスターターがなければ誰もログインしていないため、when-authorized は何も示しません。

Spring (Java) との対応

http.securityMatcher(EndpointRequest.toAnyEndpoint())
    .authorizeHttpRequests(auth -> auth
        .requestMatchers(EndpointRequest.to("health", "info")).permitAll()
        .anyRequest().hasRole("ADMIN"));

マッチャーもルールも同じです。メソッド名はセキュリティスターターに従います (securityMatcherOf、requestMatchersOf)。

関連項目