Skip to content

Commit 1e01f1a

Browse files
authored
Merge pull request #1 from webauthn4j/master
Merging upstream project
2 parents b71bf82 + abb0bfe commit 1e01f1a

File tree

8 files changed

+415
-666
lines changed

8 files changed

+415
-666
lines changed

build.gradle

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@
1717
buildscript {
1818
ext{
1919
//Plugins
20-
springBootVersion = '2.7.5'
20+
springBootVersion = '2.7.8'
2121
sonarqubeVersion = '3.5.0.2730'
2222
asciidoctorGradleVersion = "3.3.2"
2323
artifactoryVersion = '4.31.0'
2424
bintrayVersion = '1.8.5'
25-
owaspDependencyCheckVersion = '8.0.1'
25+
owaspDependencyCheckVersion = '8.0.2'
2626
httpBuilderVersion = '0.7.2'
2727

2828
//Libraries
2929
webauthn4jVersion = '0.20.6.RELEASE'
30-
springSecurityVersion = '5.7.5'
31-
hibernateValidatorVersion = '6.2.4.Final'
30+
springSecurityVersion = '5.7.6'
31+
hibernateValidatorVersion = '6.2.5.Final'
3232
thymeleafVersion = '3.0.4.RELEASE'
3333
modelMapperVersion = '3.1.1'
3434

docs/src/reference/asciidoc/en/configuration.adoc

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Please add following to pom.xml to introduce WebAuthn4J Spring Security and its
1212
<properties>
1313
...
1414
<!-- Use the latest version whenever possible. -->
15-
<webauthn4j-spring-security.version>0.7.0.RELEASE</webauthn4j-spring-security.version>
15+
<webauthn4j-spring-security.version>0.7.6.RELEASE</webauthn4j-spring-security.version>
1616
...
1717
</properties>
1818
@@ -102,7 +102,7 @@ Regarding WebAuthn4J Spring Security, `WebAuthnProcessingFilter` retrieves `cred
102102

103103
==== WebAuthn registration request processing
104104

105-
Not like authentication request processing, Servlet filter is not provided for registration request processing
105+
In contrast to authentication request processing, Servlet filter is not provided for registration request processing
106106
because in most cases, data other than WebAuthn like user's first name, last name, or email address are sent at the same time.
107107

108108
While it is basically application's responsibility to handle an authenticator registration process, WebAuthn4J Spring Security provides converters and validators to examine the received credential.
@@ -114,7 +114,7 @@ While it is basically application's responsibility to handle an authenticator re
114114
==== Options endpoints
115115

116116
Web Authentication needs to obtain a challenge from the server prior to registration and authentication.
117-
When using the FIDO-U2F token as an authentication device, the CredentialIds associated with the user identified by the first authentication factor are also need to be obtained from the server.
117+
When using the FIDO-U2F token as an authentication device, the CredentialIds associated with the user identified by the first authentication factor also need to be obtained from the server.
118118
To retrieve these data, WebAuthn4J Spring Security offers `AttestationOptionsEndpointFilter` and `AssertionOptionsEndpointFilter`.
119119

120120
=== Customization
@@ -135,7 +135,7 @@ For WebAuthn assertion verification, `WebAuthnManager` is used. See https://weba
135135
WebAuthn4J Spring Security provides `AttestationOptionsEndpointFilter` for WebAuthn JS Credential Creation API parameters serving, and `AssertionOptionsEndpointFilter` for WebAuthn JS Credential Get API parameter serving.
136136
As these Parameters generation are delegated through `AttestationOptionsProvider` and `AssertionOptionsProvider` interfaces, they can be customized by implementing these interfaces.
137137

138-
These can be customized through Java Config. Method chains from `WebAuthnLoginConfigurer`'s `attestationOptionsEndpoint` method or `assertionOptionsEndpoint` method are configuration point for that.
138+
These can be customized through Java Config. Method chains from `WebAuthnLoginConfigurer` 's `attestationOptionsEndpoint` method or `assertionOptionsEndpoint` method are configuration point for that.
139139

140140
[source,java]
141141
----
@@ -181,7 +181,7 @@ public class WebSecurityConfig {
181181

182182
===== Dynamic generation of PublicKeyCredentialUserEntity
183183

184-
Attestation options endpoint can generate `PublicKeyCredentialUserEntity` to be returned dynamically based on the `Authentication` object associated with login user.
184+
Attestation options endpoint can generate `PublicKeyCredentialUserEntity` to be returned dynamically based on the `Authentication` object associated with logged-in user.
185185
To generate `PublicKeyCredentialUserEntity`, `PublicKeyCredentialUserEntityProvider` is provided.
186186

187187
Speaking of Java Config, it can be set in this way:
@@ -203,10 +203,9 @@ public class WebSecurityConfig {
203203
}
204204
----
205205

206-
If `PublicKeyCredentialUserEntityProvider` is not set explicitly, WebAuthn4J Spring Security Java Config look up it from Spring Application Context.
206+
If `PublicKeyCredentialUserEntityProvider` is not set explicitly, WebAuthn4J Spring Security Java Config looks it up from Spring Application Context.
207207
Registering its bean to the application context is another way to set it.
208208

209-
210209
==== Selecting authentication method
211210

212211
WebAuthn4J Spring Security supports "Password-less multi-factor authentication with a user-verifying authenticator", "Multi-factor authentication with password and authenticator" and "Single-factor authentication like password".
@@ -218,7 +217,7 @@ To realize "Multi-factor authentication with password and authenticator" and "Si
218217
"Multi-factor authentication with password and authenticator" can be realized by including additional authorization requirement to check a user is authenticated by WebAuthn.
219218

220219
Whether it is authenticated by WebAuthn can be checked with the `WebAuthnSecurityExpression#isWebAuthnAuthenticated` method.
221-
Register a bean of WebAuthnSecurityExpression instance and call it from JavaConfig. WebAuthn4J Spring Security Sample MPA is a good example for it.
220+
Register a bean of `WebAuthnSecurityExpression` instance and call it from JavaConfig. WebAuthn4J Spring Security Sample MPA is a good example for it.
222221

223222
=== Advanced topics
224223

@@ -252,10 +251,10 @@ If you would like to change `rpId` dynamically based on request, set `RpIdProvid
252251

253252
==== Attestation statement verification
254253

255-
Web Authentication specification allows the relying party to retrieve an attestation statement from an authenticator if it is requested while authenticator registration.
254+
Web Authentication specification allows the relying party to retrieve an attestation statement from an authenticator if it is requested during authenticator registration.
256255
By verifying attestation statement, the relying party can exclude authenticators not conforming its security requirements.
257256
It's to be noted that the attestation statement contains information that can be used to track user across web sites, it is discouraged to request an attestation statement unnecessarily.
258-
It is also to be noted that the browsers shows an additional dialog to confirm the user consent, lowers usability.
257+
It is also to be noted that the browser shows an additional dialog to confirm the user consent, lowering usability.
259258
Except for enterprise applications that require strict verification of authenticators, most sites should not request attestation statements.
260259

261260
`WebAuthnRegistrationContextValidator` from WebAuthn4J validates an authenticator registration request, and it delegates attestation statement signature and trustworthiness validation to `WebAuthnManager` and

docs/src/reference/asciidoc/en/quick-start.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
== Quick start
33

4-
WebAuthn4J Spring Security contains a sample application demonstrates its major functionality.
4+
WebAuthn4J Spring Security contains a sample application which demonstrates its major functionality.
55

6-
It can be launched with a following command.
6+
It can be launched with the following command.
77

88
[source,bash]
99
----

docs/src/reference/asciidoc/en/sample-app.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
== Sample application
33

4-
WebAuthn4J Spring Security contains a sample application demonstrates its major functionality.
4+
WebAuthn4J Spring Security contains a sample application demonstrating its major functionalities.
55
Sample SPA is a demo of Single Page Application. Sample MPA is a demo of traditional Multi Page Application.
66
Sample SPA is explained below.
77

samples/fido-server-conformance-test-app/build.gradle

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ dependencies {
4242
implementation('org.flywaydb:flyway-core')
4343
runtimeOnly('ch.qos.logback:logback-classic')
4444
runtimeOnly('com.h2database:h2')
45-
runtimeOnly('mysql:mysql-connector-java')
45+
runtimeOnly('com.mysql:mysql-connector-j')
4646
runtimeOnly("org.lazyluke:log4jdbc-remix")
4747

4848
//Test

0 commit comments

Comments
 (0)