Skip to content

Commit

Permalink
Document passkeys dependencies
Browse files Browse the repository at this point in the history
Closes gh-16107
  • Loading branch information
rwinch committed Nov 15, 2024
1 parent 35c0351 commit cd609ac
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/modules/ROOT/pages/servlet/authentication/passkeys.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,45 @@ Passkeys are a more secure method of authenticating than passwords and are built
In order to use a passkey to authenticate, a user must first xref:servlet/authentication/passkeys.adoc#passkeys-register[Register a New Credential].
After the credential is registered, it can be used to authenticate by xref:servlet/authentication/passkeys.adoc#passkeys-verify[verifying an authentication assertion].

[[passkeys-dependencies]]
== Required Dependencies

To get started, add the `webauthn4j-core` dependency to your project.

[NOTE]
====
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[].
====

.Passkeys Dependencies
[tabs]
======
Maven::
+
[source,xml,role="primary",subs="verbatim,attributes"]
----
<dependency>
<groupId>org.springframework.security</groupId>
<artifactId>spring-security-web</artifactId>
</dependency>
<dependency>
<groupId>com.webauthn4j</groupId>
<artifactId>webauthn4j-core</artifactId>
<version>{webauthn4j-core-version}</version>
</dependency>
----
Gradle::
+
[source,groovy,role="secondary",subs="verbatim,attributes"]
----
depenendencies {
implementation "org.springframework.security:spring-security-web"
implementation "com.webauthn4j:webauthn4j-core:{webauthn4j-core-version}"
}
----
======

[[passkeys-configuration]]
== Configuration

Expand Down
1 change: 1 addition & 0 deletions docs/spring-security-docs.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ tasks.register("generateAntoraResources") {
dependencies {
testImplementation platform(project(':spring-security-dependencies'))
testImplementation 'com.unboundid:unboundid-ldapsdk'
testImplementation libs.webauthn4j.core
testImplementation 'org.apache.directory.server:apacheds-core'
testImplementation 'org.springframework:spring-core'
}
Expand Down

0 comments on commit cd609ac

Please sign in to comment.