Skip to content
This repository was archived by the owner on Nov 7, 2023. It is now read-only.

Commit 4fbc2ea

Browse files
authored
Fixes before release (#67)
1 parent 59f76f2 commit 4fbc2ea

File tree

2 files changed

+25
-3
lines changed

2 files changed

+25
-3
lines changed

packages/express-did-auth/README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,35 @@
11
<p align="middle">
2-
<img src="https://www.rifos.org/assets/img/logo.svg" alt="logo" height="100" >
2+
<img src="https://www.rifos.org/assets/img/logo.svg" alt="logo" height="100" >
33
</p>
44
<h3 align="middle"><code>express-did-auth</code></h3>
55
<p align="middle">
66
Express DID Auth
77
</p>
8+
<p align="middle">
9+
<a href="https://rsksmart.github.io/rif-identity-docs/ssi/specs/did-auth">
10+
<img src="https://img.shields.io/badge/-specs-lightgrey" alt="specs" />
11+
</a>
12+
<a href="https://rsksmart.github.io/rif-identity-docs/ssi/libraries/express-did-auth">
13+
<img src="https://img.shields.io/badge/-docs-brightgreen" alt="docs" />
14+
</a>
15+
<a href="https://badge.fury.io/js/%40rsksmart%2Fexpress-did-auth">
16+
<img src="https://badge.fury.io/js/%40rsksmart%2Fexpress-did-auth.svg" alt="npm" />
17+
</a>
18+
</p>
819

920
```
1021
npm i @rsksmart/express-did-auth
1122
```
1223

1324
This module includes a plug and play authentication framework to be used in Express applications, it implements the DID Authentication protocol designed by RIF Identity.
1425

26+
## Features
27+
28+
- **Sign up** flow authenticating user's DID and Verifiable Credentials
29+
- **Sign in** flow authenticating user's DID
30+
- **Authenticate requests** using Express middleware
31+
- **Log out** flow
32+
1533
## Usage
1634

1735
This approach will add the following endpoints to your app:
@@ -22,7 +40,6 @@ This approach will add the following endpoints to your app:
2240
- POST `/refresh-token`
2341
- POST `/logout`
2442

25-
2643
```typescript
2744
import express from 'express'
2845
import setupApp from '@rsksmart/express-did-auth'
@@ -54,6 +71,10 @@ app.listen(port, () => logger.info(`My express API with did-auth running in ${po
5471

5572
Check out more configuration options and usage details in our [RSK Developers Portal](https://developers.rsk.co/rif/identity/).
5673

74+
## Open work
75+
76+
- Formalize and implement Selective Disclosure request standard schema
77+
5778
## Test
5879

5980
From base repo directory run `npm test` or any of the described [test script variants](../../README#test).
@@ -65,4 +86,4 @@ From base repo directory run `npm test` or any of the described [test script var
6586
- [RFC-1994 - PPP Challenge Handshake Authentication Protocol (CHAP)](https://tools.ietf.org/html/rfc1994)
6687
- [Verifiable Credentials JSON Schema Specification](https://w3c-ccg.github.io/vc-json-schemas/)
6788
- [The OAuth 2.0 Authorization Framework](https://tools.ietf.org/html/rfc6749)
68-
- [uPort selective disclosure implementation](https://developer.uport.me/flows/selectivedisclosure)
89+
- [uPort selective disclosure implementation](https://developer.uport.me/flows/selectivedisclosure)

packages/express-did-auth/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
"description": "Authentication with Verifiable Credentials for Express.js",
55
"main": "lib/index.js",
66
"types": "lib/index.d.ts",
7+
"files": ["lib/"],
78
"scripts": {
89
"build": "tsc"
910
},

0 commit comments

Comments
 (0)