Skip to content

Commit

Permalink
Fix conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
pheyvaer committed Mar 17, 2023
2 parents 8be13af + cdf8d68 commit 24d274d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
dist
node_modules
.DS_Store
.idea
web-ext-artifacts
.DS_Store
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Solid Authentication Extension

A firefox extension that replaces unauthenticated requests with authenticated Solid requests on Community Solid Servers.
This FireFox extension replaces unauthenticated requests with authenticated Solid requests.
This extension only works with WebIDs that use
the [Community Solid Server](https://github.com/CommunitySolidServer/CommunitySolidServer)
as identity provider.

## Client Credentials

Requests are authenticated using the [Client Credentials API](https://communitysolidserver.github.io/CommunitySolidServer/5.x/usage/client-credentials/)
Requests are authenticated using the
[Client Credentials API](https://communitysolidserver.github.io/CommunitySolidServer/5.x/usage/client-credentials/)

The extension uses temporary access tokens that are created using either the client's email and password used on the server or a previously created id and secret linked to the user's WebID on the server.

Expand All @@ -29,7 +33,7 @@ The extension should now be running, both it's browser popup and the background
If you can't find the extension icon which opens the popup window, it's most likely unpinned and hidden away in the extension menu which can be opened by clicking the jigsaw icon on the top right of the browser window.


# Session
## Session

The extension will remember your credentials (ID & Secret combination) in your browser storage.

Expand All @@ -39,7 +43,7 @@ This will allow the extension to restore and reuse your previously generated id
Because the extension is not [signed](https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox) yet, it's [add-on id](https://extensionworkshop.com/documentation/develop/extensions-and-the-add-on-id/)
is not static yet. Because of this, if you remove and reload the extension or restart your browser and reload the extension, the extension won't find it's previously saved credentials in the browser storage and you will have to log in again.

# GET requests only
## GET requests only

At this time, the extension will only add authentication to GET requests.
POST requests will not be blocked, but won't have any authentication either.
Expand All @@ -52,3 +56,7 @@ and [requesting access tokens from said url](https://github.com/KNowledgeOnWebSc
To prevent an infinite loop of blocking web request listeners catching each other, any POST request that is caught,
[will be passed](https://github.com/KNowledgeOnWebScale/solid-authentication-browser-extension/blob/8211dab9b7a42fa98eeef37158084788e62d251a/src/js/background.js#L48-L50)
before any token url or access token is requested, and consequently any authentication is added.

## Screencast

You find a screencast of the extension [here](https://cloud.ilabt.imec.be/index.php/s/QbabTcHkX2J8GHG).

0 comments on commit 24d274d

Please sign in to comment.