認証
認証は「あなたは誰か?」に答えます。ログインのリクエスト (名前とパスワード、トークン) は AuthenticationManager に渡り、認証されたユーザーを返すか AuthenticationException を投げます。パスワードログインでは、ユーザーがどこから来るか、つまり UserDetailsService だけを書きます。チェックはスターターの DaoAuthenticationProvider が、ユーザーの列挙やタイミング攻撃に対する Spring の保証とともに行います。
使う理由
ログインのチェックは単純に見えますが、微妙に間違えやすいものです。「そのようなユーザーはいない」を「パスワードが違う」より速く返すと、どのアカウントが存在するかを攻撃者に教えてしまいます。ハッシュを不注意に比較すると時間が漏れます。ロックされたアカウントは、パスワードが何であれロックされたままでなければなりません。プロバイダーはこれらすべてを Spring と同じように行い、あなたは自分の部分、つまりユーザーの読み込みだけを持てば済みます。
例
// ユーザーテーブルを UserDetailsService として。
@Service()
class AccountUsers implements UserDetailsService {
AccountUsers(this.accounts);
final AccountRepository accounts;
@override
Future<UserDetails> loadUserByUsername(String username) async {
final row = await accounts.findByEmail(username) ??
(throw UsernameNotFoundException('No user $username'));
return User.withUsername(row.email)
.password(row.passwordHash) // {argon2}$argon2id$...
.roles(row.roles) // ['ADMIN'] は ROLE_ADMIN になる
.accountLocked(row.locked)
.build();
}
}
その Bean があれば、自動構成が AuthenticationManager を組み立てます。その上の DaoAuthenticationProvider で、PasswordEncoder Bean、なければデリゲーティングエンコーダーを使います。ユーザーをログインさせるには、それを注入します。
final result = await authenticationManager.authenticate(
UsernamePasswordAuthenticationToken.unauthenticated('[email protected]', password),
);
SecurityContextHolder.setContext(SecurityContextImpl(result));
サーバーでは、セキュリティスターターのフォームログインと Basic ログインがこれを呼び出します。
ユーザー
| 型 | 内容 |
|---|---|
UserDetails |
ユーザー: username、password (ハッシュ)、authorities、そしてフラグ isAccountNonExpired、isAccountNonLocked、isCredentialsNonExpired、isEnabled。 |
User |
標準の UserDetails。User.withUsername(name) または User.withUserDetails(other) で組み立てる。 |
UserDetailsService |
loadUserByUsername(name)。同期または Future。ユーザーがいなければ UsernameNotFoundException を投げる。 |
UserDetailsManager |
createUser、updateUser、deleteUser、userExists を追加する。 |
InMemoryUserDetailsManager |
リストの上の UserDetailsManager。開発とテスト用。 |
UserDetailsPasswordService |
updatePassword(user, newHash): アップグレードされたハッシュの保存先。 |
User.withUsername のビルダーのステップ: password、passwordEncoder (build 時にパスワードに適用される関数)、roles (ROLE_ を付ける)、authorities、authorityNames (完全な名前で書く)、accountExpired、accountLocked、credentialsExpired、disabled、そして build()。
AuthenticationManager
| 型 | 働き |
|---|---|
AuthenticationManager |
authenticate(request) は認証された Authentication を返すか、例外を投げる。 |
ProviderManager |
その AuthenticationProvider に順に問い合わせ、次に任意の parent に問い合わせる。 |
AuthenticationProvider |
supports(request) と authenticate(request)。次のプロバイダーに判断を任せるには null を返す。 |
DaoAuthenticationProvider |
UserDetailsService と PasswordEncoder の上のパスワードログイン。 |
自動構成が組み立てるもの:
UserDetailsServiceBean がある場合: その上のDaoAuthenticationProvider。AuthenticationProviderBean がある場合: そのすべての上のProviderManager。- 独自の
AuthenticationManagerBean がある場合: それを手を加えずに使います。
独自のプロバイダー、例えば API キーのためのもの:
@Component()
class ApiKeyProvider implements AuthenticationProvider {
@override
bool supports(Authentication authentication) => authentication is ApiKeyToken;
@override
Future<Authentication?> authenticate(Authentication authentication) async {
final key = authentication as ApiKeyToken;
final client = await clients.findByKey(key.value) ??
(throw BadCredentialsException('Unknown key'));
return ApiKeyToken.authenticated(client.name, [SimpleGrantedAuthority('ROLE_CLIENT')]);
}
}
DaoAuthenticationProvider が保証すること
Spring のものと同じく:
- 未知のユーザーと誤ったパスワードは同じように失敗し (
BadCredentialsException)、未知のユーザーでもダミーのハッシュに対してパスワードをチェックします。そのため、応答からもその時間からも、ユーザーが存在するかはわかりません。 - ロックされた、無効な、期限切れのアカウントはパスワードのチェックより前に失敗し、期限切れのパスワードはその後に失敗します。
- どのエンコーダーも理解できない保存されたハッシュ (
{bcrypt}など) は、ログに警告を出して誤ったパスワードとして失敗します。決してログインさせません。 - 古い設定 (別の
{id}、より弱いパラメーター) で作られたハッシュは、ログインに成功した後に再ハッシュされ、UserDetailsPasswordServiceBean、またはユーザーサービス自体がそれである場合はユーザーサービスを通じて保存されます。 - 結果のプリンシパルは、権限を持つ読み込まれた
UserDetailsで、そのクレデンシャルは消去されます。
パスワードのチェックには上限がある
パスワードのハッシュ化には数百ミリ秒の CPU と、Argon2 では数メガバイトのメモリが必要です。Dart VM では、ログインのチェックは別の isolate で実行されるため、ログインがサーバーの他のリクエストを止めることはありません。Web ではその場で実行されます。アップグレードされたパスワードの再ハッシュはメインの isolate で実行されます。
同時に実行されるチェックは最大 spring.security.password-checks.max-concurrent 個 (デフォルトはプロセッサー数の半分、最低一つ) で、待機は最大 max-queued 個 (その 8 倍) です。それ以上のものは CPU を使わずに即座に PasswordChecksBusyException で失敗します。セキュリティスターターはこれに 503 と Retry-After で応答し、失敗したログインとして扱うことはありません。そのため、誤ったパスワードの大量送信が使う CPU は最大でも半分です。すべてのプロパティ を参照してください。
例外
| 例外 | 発生する場面 |
|---|---|
BadCredentialsException |
名前またはパスワードが誤っている。 |
UsernameNotFoundException |
UserDetailsService が投げる。プロバイダーが BadCredentialsException に変換する。 |
DisabledException、LockedException、AccountExpiredException、CredentialsExpiredException |
アカウントの状態 (AccountStatusException)。 |
ProviderNotFoundException |
リクエストに対応するプロバイダーがない。 |
AuthenticationServiceException、InternalAuthenticationServiceException |
ユーザーストアが失敗した。 |
InsufficientAuthenticationException |
より強いログインが必要。 |
AuthenticationCredentialsNotFoundException |
認証がまったくない状態で保護されたメソッドが呼ばれた。 |
AccessDeniedException |
ログイン済みだが、許可されていない。 |
PasswordChecksBusyException |
同時に行うパスワードのチェックが多すぎる。何もチェックされていない。 |
イベント
すべてのログインはアプリケーションイベントを発行します: AuthenticationSuccessEvent (Web のログインでは InteractiveAuthenticationSuccessEvent も)、または失敗のイベント: AuthenticationFailureBadCredentialsEvent、AuthenticationFailureDisabledEvent、AuthenticationFailureLockedEvent、AuthenticationFailureExpiredEvent、AuthenticationFailureCredentialsExpiredEvent、AuthenticationFailureProviderNotFoundEvent、AuthenticationFailureServiceExceptionEvent。ログアウトは LogoutSuccessEvent を発行します。
アカウントをロックしたりクライアントを遅くしたりするには、これらを受け取ってください。パッケージ自身は試行を数えません。
@Component()
class FailedLogins {
@EventListener()
void onFailure(AuthenticationFailureBadCredentialsEvent event) =>
print('failed login for ${event.authentication.name}');
}
Spring (Java) との対応
@Bean
UserDetailsService users(AccountRepository accounts) {
return username -> accounts.findByEmail(username)
.map(row -> User.withUsername(row.email()).password(row.hash()).roles(row.roles()).build())
.orElseThrow(() -> new UsernameNotFoundException(username));
}
型と保証は Spring Security のものです。loadUserByUsername は Future を返せます。authenticate は Future を返します。まだないもの: JdbcUserDetailsManager、LDAP、漏洩したパスワードのチェック、多要素の権限。