Added initial README.md

This commit is contained in:
Jack Yu 2024-10-26 21:49:45 -07:00
parent 860fa8ad90
commit b95c60972f
1 changed files with 30 additions and 0 deletions

30
README.md Normal file
View File

@ -0,0 +1,30 @@
WebRTC-PoC
==========
WebRTC fingerprint authentication proof-of-concept.
Build Instructions
------------------
```bash
$ npm install
$ npm start
```
PoC will be available at `http://0.0.0.0:3000`.
Key Components
--------------
This PoC demonstrates the possibility of the following:
1. Generate, store, and load a specific RTCCertfiicate.
2. Upload the certificate fingerprint to a webserver.
3. Establish a WebRTC session between two browser instances, verify the
certificate used has been registered and terminate the connection if not.
Currently this only runs on Chrome due to client-side JS calling a
`RTCCertificate.getfingerprint()` function. However, it shouldn't be too
hard creating a shim for this function to work with FireFox, at the cost of
some performance issues (and potentially making the function async).