Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
MKodde committed Apr 8, 2024
1 parent 738e11e commit 293281c
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 16 deletions.
6 changes: 2 additions & 4 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ Install (with build archive)

### 1. Copy and configure the configuration files

```cp .env.dist .env```

```cp config/packages/parameters.yml.dist config/packages/parameters.yml```
```cp config/openconext/parameters.yml.dist config/openconext/parameters.yml```

### 2. Create archive

Expand Down Expand Up @@ -45,7 +43,7 @@ Install (without build archive)

```cp .env.dist .env```

```cp config/packages/parameters.yml.dist config/packages/parameters.yml```
```cp config/openconext/parameters.yml.dist config/openconext/parameters.yml```

```composer dump-env prod```

Expand Down
29 changes: 17 additions & 12 deletions docs/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,32 +24,37 @@ If everything goes as planned you can develop inside the virtual machine

``` docker exec -it stepup-webauthn-1 bash ```

### 2. Prepare the MetadataStatementService
We use the Fido JWS MDS Blob file to verify if Webauthn tokens are trustworthy. Here we follow the principle. If a
token is verified by Fido and has at least a level 1 score. The token is good enough for us.

### 2. Build frontend assets:
2 files need to be present in the `config/openconext/mds` folder. They are:

```config/openconext/mds/blob.jwt```
```config/openconext/mds/fido2-mds.cer```

The blob containing the registry of metadata statements can be found here: https://fidoalliance.org/metadata/ (see the Obtaining blob section)

The Blob file is signed by the FIDO Alliance. To verify the signature we need the appropriate certificate. This certificate is not downloaded on demand, but we
also track it. This is the location the cert can be found on the fido page linked in the paragraph above. Also in the Obtaining blob section.

The provided dist files should result in a working application. But might not work with brand-new tokens.

### 3. Build frontend assets:

``` yarn ```

``` yarn encore dev ```

``` ./bin/console assets:install ```

### 3. Create configuration files
### 4. Create configuration files

Copy and configure:

```cp .env.dist .env```

```cp config/openconext/parameters.yaml.dist config/openconext/parameters.yaml```

### 4. Create database
```
bin/console doctrine:migrations:migrate
```

If everything goes as planned you can go to:

[https://webauthn.dev.openconext.local](https://webauthn.dev.openconext.local)

### Development

All frond-end logic is written in sass and typescript. You can run a watcher to update these automatically

0 comments on commit 293281c

Please sign in to comment.