Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Webauthn official link #29

Merged
merged 1 commit into from Aug 25, 2022
Merged

Add Webauthn official link #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions rpserver/src/main/java/com/linecorp/line/auth/fido/fido2/rpserver/config/SwaggerConfig.java
View file
Open in desktop
Expand Up @@ -49,9 +49,9 @@ public Docket api() {
private ApiInfo metaData() {
return new ApiInfoBuilder()
.title("FIDO2 RP SERVER REST API")
.description("FIDO2 RP SEVER REST API for RP SERVER IMPLEMENTATION")
.description("If you want to know the details of the WebAuthn standard, you can also refer to the official documentation. \n\n https://www.w3.org/TR/webauthn-2/" )
.version("1.0.0")
.contact(new Contact("Kyung-Joon Park", null, "kyungjoon.park@linecorp.copm"))
.contact(new Contact("Kyung-Joon Park", null, "kyungjoon.park@linecorp.com"))
.build();
}
}
10 changes: 9 additions & 1 deletion server/src/docs/asciidoc/api-guide.adoc
View file
Open in desktop
Expand Up @@ -18,6 +18,14 @@ For more information, please see README.md at the link below.

https://github.com/line/line-fido2-server



If you want to know the details of the WebAuthn standard, you can also refer to the official documentation.

https://www.w3.org/TR/webauthn-2/



Basically, FIDO2 has the following operations - Registration, Authentication.

Example APIs worked like this:
Expand Down Expand Up @@ -77,4 +85,4 @@ operation::credential-controller-test/delete-credential-with-user-id-id-and-rp-i
NOTE: This is not within the scope of the WebAuthn specification but its own API.

=== Get Health Check Status
operation::health-check-controller-test/health-check_success[snippets='http-request,http-response']
operation::health-check-controller-test/health-check_success[snippets='http-request,http-response']
4 changes: 2 additions & 2 deletions server/src/main/java/com/linecorp/line/auth/fido/fido2/server/config/SwaggerConfig.java
View file
Open in desktop
Expand Up @@ -48,9 +48,9 @@ public Docket api() {
private ApiInfo metaData() {
return new ApiInfoBuilder()
.title("FIDO2 SERVER REST API")
.description("FIDO2 (WebAuthN) SEVER REST API")
.description("If you want to know the details of the WebAuthn standard, you can also refer to the official documentation. \n\n https://www.w3.org/TR/webauthn-2/" )
.version("1.0.0")
.contact(new Contact("Kyung-Joon Park", null, "kyungjoon.park@linecorp.copm"))
.contact(new Contact("Kyung-Joon Park", null, "kyungjoon.park@linecorp.com"))
.build();
}
}
16 changes: 11 additions & 5 deletions server/src/main/resources/static/docs/api-guide.html
View file
Open in desktop
Expand Up @@ -545,6 +545,12 @@ <h1 id="introduction" class="sect0"><a class="link" href="#introduction">Introdu
<p><a href="https://github.com/line/line-fido2-server" class="bare">https://github.com/line/line-fido2-server</a></p>
</div>
<div class="paragraph">
<p>If you want to know the details of the WebAuthn standard, you can also refer to the official documentation.</p>
</div>
<div class="paragraph">
<p><a href="https://www.w3.org/TR/webauthn-2/" class="bare">https://www.w3.org/TR/webauthn-2/</a></p>
</div>
<div class="paragraph">
<p>Basically, FIDO2 has the following operations - Registration, Authentication.</p>
</div>
<div class="paragraph">
Expand Down Expand Up @@ -631,7 +637,7 @@ <h5 id="_get_reg_challenge_http_response"><a class="link" href="#_get_reg_challe
"id" : "65fUCTlqPlOSk22tkrkJ2m8I2MEhpF4fCI_pdosMAzk",
"displayName" : "Test Display Name"
},
"challenge" : "XR2NGK0HZW1-gUeuaPoLpf48ZFjz0sN2e5QfWZN7aIgjeXPksmJmJ0F0Oq9DHGZ74EvzejyEW6PHADMLxdqeng",
"challenge" : "TXgZfiz2B88oNbksOpC4GjNQ8YNaFzntXMBTMdN3K1XgIgKRr3FoXltAhV1zNmmdF4WJhxnoQDeq4s0bARhtRg",
"pubKeyCredParams" : [ {
"type" : "public-key",
"alg" : -65535
Expand Down Expand Up @@ -677,7 +683,7 @@ <h5 id="_get_reg_challenge_http_response"><a class="link" href="#_get_reg_challe
"userVerification" : "preferred"
},
"attestation" : "none",
"sessionId" : "6f5a8fbb-e801-4077-9b90-f5598a419604",
"sessionId" : "8bfc693e-8582-45e1-ad08-e2b71901cc97",
"extensions" : {
"credProps" : true
}
Expand Down Expand Up @@ -794,15 +800,15 @@ <h5 id="_get_auth_challenge_http_response"><a class="link" href="#_get_auth_chal
"internalErrorCode" : 0,
"internalErrorCodeDescription" : null
},
"challenge" : "nf15HXQ11EdR8ckcVJn-UDt59rHSnOF0JEgB53W65CZX2IL1pAf22XEIXnGnkCHssogQZ4VWHfDa3u7VSScEkw",
"challenge" : "7ZKNccKcYL0Rky0YqVx-_-yHDudCPScBayiw17arUfzpAfqa-A8nv-OmQbSLMHtpEE0rp0MbblIzLw-bE5x6zQ",
"timeout" : 180000,
"rpId" : "localhost",
"allowCredentials" : [ {
"type" : "public-key",
"id" : "AUTjvBgL29DEg4aoRVchh4KSi9cLUmNuL4JqH4H8RTvKaBVDu88CnXGHDTkpIag5ODydvM-UP5FgqzDzzM3A_tzLSeoWc7hnkQK3g0N0jifjatDHgXX6YmMVAJc"
} ],
"userVerification" : "preferred",
"sessionId" : "048fc496-7de8-41e7-acf7-6da60885f436",
"sessionId" : "3d310653-8d7a-449e-975e-30a467dfbe9a",
"extensions" : { }
}</code></pre>
</div>
Expand Down Expand Up @@ -1235,7 +1241,7 @@ <h4 id="_get_health_check_status_http_response"><a class="link" href="#_get_heal
<div id="footer">
<div id="footer-text">
Version 0.1.1-SNAPSHOT<br>
Last updated 2021-11-06 19:24:20 +0900
Last updated 2022-08-18 10:39:04 +0900
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
Expand Down