packages/server/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# @simplewebauthn/server <!-- omit in toc -->

![WebAuthn](https://img.shields.io/badge/WebAuthn-Simplified-blueviolet?style=for-the-badge&logo=WebAuthn)
[![npm (scoped)](https://img.shields.io/npm/v/@simplewebauthn/server?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@simplewebauthn/server)

- [Installation](#installation)
  - [Node LTS 20.x or higher](#node-lts-20x-or-higher)
  - [Deno v1.33.x or higher](#deno-v133x-or-higher)
- [Usage](#usage)
- [Supported Attestation Formats](#supported-attestation-formats)

## Installation

### Node LTS 20.x or higher

This package is available on **npm** and supports **both CommonJS and
[ECMAScript modules (ESM)](https://nodejs.org/api/esm.html#enabling)** projects:

```sh
npm install @simplewebauthn/server
```

### Deno v1.33.x or higher

It is also available for import into Deno projects from **deno.land/x**:

```ts
import {...} from 'https://deno.land/x/simplewebauthn/deno/server.ts';
```

## Usage

You can find in-depth documentation on this package here:
https://simplewebauthn.dev/docs/packages/server

## Supported Attestation Formats

SimpleWebAuthn supports
[all current WebAuthn attestation formats](https://w3c.github.io/webauthn/#sctn-defined-attestation-formats),
including:

- **Android Key**
- **Android SafetyNet**
- **Apple**
- **FIDO U2F**
- **Packed**
- **TPM**
- **None**