Skip to content

Commit

Permalink
Merge pull request #1581 from webauthn4j/update-doc
Browse files Browse the repository at this point in the history
Update docs regarding recent project changes
  • Loading branch information
ynojima authored Dec 31, 2024
2 parents a187da8 + 95c9655 commit 9f3a7d5
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ self-contained bootstrap mechanism for the build.

### Prerequisites

- Java8 or later
- Spring Framework 5.0 or later
- Java17 or later
- Spring Framework 6.0 or later

### Checkout sources

Expand Down
12 changes: 6 additions & 6 deletions docs/src/reference/asciidoc/en/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,18 @@ WebAuthn4J Spring Security is a Spring Security extension module to provide Web
WebAuthn4J Spring Security uses https://github.com/webauthn4j/webauthn4j[WebAuthn4J] for WebAuthn attestation and assertion verification.
WebAuthn4J is a portable Java library that supports all the attestation statements, but has minimal dependencies on external libraries.

==== Spring Security WebAuthn
==== Spring Security Passkeys

There is also a sister project called Spring Security WebAuthn. Spring Security WebAuthn is developed according to Spring Security project's policy, aiming to be merged into Spring Security upstream.
WebAuthn4J Spring Security is developed as a WebAuthn4J project with the aim of maximizing the functions of the WebAuthn4J library.
Since Spring Security 6.4, https://docs.spring.io/spring-security/reference/servlet/authentication/passkeys.html[passkey support has been added to `spring-security-web`]. It uses the WebAuthn4J library too, but is maintained by the Spring Security project.
On the other hand, this WebAuthn4J Spring Security is maintained by the WebAuthn4J project.

=== Requirements

==== Language & Framework

* Java8 or later
* Spring Framework 5 or later
* Spring Security 5 or later
* Java17 or later
* Spring Framework 6 or later
* Spring Security 6 or later

==== Environment

Expand Down
12 changes: 6 additions & 6 deletions docs/src/reference/asciidoc/ja/introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,18 @@ Spring Securityで保護されたWebアプリケーションに対して、Web A
WebAuthnのアサーションの検証に関わるコアの処理は https://github.com/webauthn4j/webauthn4j[WebAuthn4J] という別のプロジェクトで開発を進めています。
WebAuthn4Jは、 全ての構成証明ステートメント(Attestation)をサポートしながら、外部ライブラリへの依存関係は最小限に抑えたポータブルなJavaライブラリです。

==== Spring Security WebAuthnとの関係
==== Spring SecurityのPasskeyサポートとの関係

Spring Security WebAuthnという姉妹プロジェクトも存在します。Spring Security WebAuthnは、Spring Security本体へのマージを目指してSpring Securityプロジェクトの方針に則って開発されている一方、
WebAuthn4J Spring Securityは、WebAuthn4Jのプロジェクトとして、WebAuthn4Jライブラリの機能を最大限に、またより早く取り込むことを目的に開発を進めています
Spring Security 6.4から、Passkeysサポートが追加されました。こちらもWebAuthn4Jライブラリを使用していますが、Spring Securityプロジェクトでメンテナンスされています。
一方、このWebAuthn4J Spring Securityは、WebAuthn4Jプロジェクトによってメンテナンスされています

=== 要件

==== 言語・フレームワーク

* Java8以降
* Spring Framework 5以降
* Spring Security 5以降
* Java17以降
* Spring Framework 6以降
* Spring Security 6以降

==== 動作環境

Expand Down

0 comments on commit 9f3a7d5

Please sign in to comment.