Skip to content

Commit ab0fdff

Browse files
authored
Add table of contents to README.md
1 parent a87d7a4 commit ab0fdff

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,44 @@ try {
188188
...
189189
```
190190

191+
# Table of contents
192+
193+
- [Quickstart](#quickstart)
194+
- [1. Add the library to your project](#1-add-the-library-to-your-project)
195+
- [2. Add cache support](#2-add-cache-support)
196+
- [3. Configure the nonce generator](#3-configure-the-nonce-generator)
197+
- [4. Add trusted certificate authority certificates](#4-add-trusted-certificate-authority-certificates)
198+
- [5. Configure the authentication token validator](#5-configure-the-authentication-token-validator)
199+
- [6. Add a REST endpoint for issuing challenge nonces](#6-add-a-rest-endpoint-for-issuing-challenge-nonces)
200+
- [7. Implement authentication](#7-implement-authentication)
201+
- [Introduction](#introduction)
202+
- [Token validation](#token-validation)
203+
- [Basic usage](#basic-usage)
204+
- [Configuration](#configuration)
205+
- [Certificate fingerprint](#certificate-fingerprint)
206+
- [What gets validated](#what-gets-validated)
207+
- [Possible validation errors](#possible-validation-errors)
208+
- [NonceNotFoundException](#noncenotfoundexception)
209+
- [NonceExpiredException](#nonceexpiredexception)
210+
- [OriginMismatchException](#originmismatchexception)
211+
- [ServiceCertificateFingerprintValidationException](#servicecertificatefingerprintvalidationexception)
212+
- [TokenExpiredException](#tokenexpiredexception)
213+
- [TokenParseException](#tokenparseexception)
214+
- [TokenSignatureValidationException](#tokensignaturevalidationexception)
215+
- [UserCertificateExpiredException](#usercertificateexpiredexception)
216+
- [UserCertificateMissingPurposeException](#usercertificatemissingpurposeexception)
217+
- [UserCertificateNotTrustedException](#usercertificatenottrustedexception)
218+
- [UserCertificateNotYetValidException](#usercertificatenotyetvalidexception)
219+
- [UserCertificateParseException](#usercertificateparseexception)
220+
- [UserCertificateRevocationCheckFailException](#usercertificaterevocationcheckfailexception)
221+
- [UserCertificateRevokedException](#usercertificaterevokedexception)
222+
- [UserCertificateWrongPurposeException](#usercertificatewrongpurposeexception)
223+
- [Create your own validator implementation](#create-your-own-validator-implementation)
224+
- [Nonce generation](#nonce-generation)
225+
- [Basic usage](#basic-usage-1)
226+
- [Configuration](#configuration-1)
227+
- [How it works](#how-it-works)
228+
191229
# Introduction
192230

193231
This library has everything that it takes to ensure that the authentication token sent by the Web-eID browser extension contains valid data. And that this data is consistent and was not modified in-between by the third party. It is easy to configure and to integrate into your authentication service.

0 commit comments

Comments
 (0)