Skip to content

Commit cd609ac

Browse files
committed
Document passkeys dependencies
Closes gh-16107
1 parent 35c0351 commit cd609ac

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

docs/modules/ROOT/pages/servlet/authentication/passkeys.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,45 @@ Passkeys are a more secure method of authenticating than passwords and are built
77
In order to use a passkey to authenticate, a user must first xref:servlet/authentication/passkeys.adoc#passkeys-register[Register a New Credential].
88
After the credential is registered, it can be used to authenticate by xref:servlet/authentication/passkeys.adoc#passkeys-verify[verifying an authentication assertion].
99

10+
[[passkeys-dependencies]]
11+
== Required Dependencies
12+
13+
To get started, add the `webauthn4j-core` dependency to your project.
14+
15+
[NOTE]
16+
====
17+
This assumes that you are managing Spring Security's versions with Spring Boot or Spring Security's BOM as described in xref:getting-spring-security.adoc[].
18+
====
19+
20+
.Passkeys Dependencies
21+
[tabs]
22+
======
23+
Maven::
24+
+
25+
[source,xml,role="primary",subs="verbatim,attributes"]
26+
----
27+
<dependency>
28+
<groupId>org.springframework.security</groupId>
29+
<artifactId>spring-security-web</artifactId>
30+
</dependency>
31+
<dependency>
32+
<groupId>com.webauthn4j</groupId>
33+
<artifactId>webauthn4j-core</artifactId>
34+
<version>{webauthn4j-core-version}</version>
35+
</dependency>
36+
----
37+
38+
Gradle::
39+
+
40+
[source,groovy,role="secondary",subs="verbatim,attributes"]
41+
----
42+
depenendencies {
43+
implementation "org.springframework.security:spring-security-web"
44+
implementation "com.webauthn4j:webauthn4j-core:{webauthn4j-core-version}"
45+
}
46+
----
47+
======
48+
1049
[[passkeys-configuration]]
1150
== Configuration
1251

docs/spring-security-docs.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ tasks.register("generateAntoraResources") {
3434
dependencies {
3535
testImplementation platform(project(':spring-security-dependencies'))
3636
testImplementation 'com.unboundid:unboundid-ldapsdk'
37+
testImplementation libs.webauthn4j.core
3738
testImplementation 'org.apache.directory.server:apacheds-core'
3839
testImplementation 'org.springframework:spring-core'
3940
}

0 commit comments

Comments
 (0)