A secret sharing platform with expiring links. Up and running here: https://youshallnotpass.org
Backend is running on Azure at https://youshallnotpassbackend.azurewebsites.net
To use the POST /vault
endpoint, first get a token using GET /security/authenticate
. This endpoint returns a token as a string with an expiration date. To get the token, you'll need to know your service name and secret key (message Madeline).
To use the token, add Bearer [token]
to the Authorization
header of your request (Python Example). Before reusing the token, check if it's about to expire, and get a new one if it is.
To run locally (message Madeline to setup the users database before proceeding),
- First, install .Net 6
- Define a server key
- Navigate to
Backend/Api/
- Run
dotnet user-secrets init
- Go to this site and generate a 128 bit key with hex format (for example,
217A25432A462D4A614E645266556A58
) - Run
dotnet user-secrets set "ServerKey" "[key]"
- Navigate to
- Two options:
- Visual Studio
- Install Visual Studio (make sure to inlcude the web development workload)
- Open
Backend/YouShallNotPassBackend.sln
in Visual Studio - Run the
YouShallNotPassBackend
application
- Command Line
- Navigate to
Backend/Api/
- Run
dotnet run
, the url will show in the terminal - The root index is a swagger UI that shows all of the APIs and how to use them (see
/Backend/ContentType.cs
for the enum definitions)
- Navigate to
- Visual Studio
To run the Api Tests (message Madeline to setup test authentication credentials before proceeding),
- First, install .Net 6
- If testing a local deployment, run the server locally
- Two options:
- Visual Studio (only available on Windows)
- Install Visual Studio (make sure to inlcude the web development workload)
- Open
Backend/YouShallNotPassBackend.sln
in Visual Studio - Go to
Test -> Configure Run Settings -> Select Solution Wide runsettings File
and select one ofRunSettings/[local|azure].runsettings
- Right-click on the
YouShallNotPassBackendApiTests
project in Solution Explorer and clickRun Tests
- Command Line
- Navigate to
Backend/ApiTests/
- Run
dotnet test -s RunSettings/[local|azure].runsettings
- Navigate to
- Visual Studio (only available on Windows)
To run the frontend locally, first ensure that Node, React, and Typescript are installed. Then, run:
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
Sign in to your Google Account on a Chrome device or Chrome browser on a Windows, Mac, or Linux computer.
Go to chrome://extensions/.
At the top right, turn on Developer mode.
Click Load unpacked.
Find and select extension folder: \YouShallNotPass\gmailextension\chrome\templates
Open a new tab in Chrome then click the extension.