Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/irby/passwordless-authenticator-poc
A passwordless authenticator that allows users to share their accounts with other users. Golang / Angular
https://github.com/irby/passwordless-authenticator-poc
Last synced: about 15 hours ago
JSON representation
A passwordless authenticator that allows users to share their accounts with other users. Golang / Angular
- Host: GitHub
- URL: https://github.com/irby/passwordless-authenticator-poc
- Owner: irby
- Created: 2022-09-28T00:54:52.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T00:58:47.000Z (over 1 year ago)
- Last Synced: 2023-03-07T04:07:07.533Z (over 1 year ago)
- Language: Go
- Homepage:
- Size: 25.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Passwordless Authenticator Proof-of-Concept
[](https://deepsource.io/gh/irby/passwordless-authenticator-poc/?ref=repository-badge)
## Allow users to securely share their accounts in a passwordless environment
#### Contributors:
- Matthew H. Irby ([email protected])
#### Related Projects
- Hanko ([repo](https://github.com/teamhanko/hanko)) - The authenticator backend of this project is branched off of this project.
This project represents my capstone project for Fall 2022 at the Georgia Institute of Technology. All work here is for educational and research purposes, and it is not yet suited for production usage.
# Concept
After many years of design and gradual adoption, passwordless authentication is now being adopted by large companies such as Mirosoft, Apple, and Google. Passwordless authentication is designed to eliminate a large target for malicious users: passwords.
As it is currently designed, passwordless authentication does not allow users to be able to share their accounts with others. I would like to introduce a novel concept of allowing users to securely share their accounts without risk of account takeover, and also allow IT auditing to identify which individual is accessing an account.
# Dependencies
## Running from Docker
In order to run the project locally using Docker, the following must be installed:
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)
## Running Locally
- Go
- Node (>=16.16.0) / NVM
- PostgreSQL (optionally, can run from Docker)
# Project Structure
The project contains the following structure:
- ### Authenticator Backend
- This contains the code to run the authenticator API. The authenticator API will be consume by the authenticator front end, client front-end and client back-end.
- ### ~~Authenticator Frontend~~ (not used)
- The contains the code for the authenticator front-end that will be run by two different users on differing sessions: the primary account holder and another user the account holder will share the account with.
- ### ~~Client API~~ (not used)
- This contains the code to run the client app's backend. The client API will send the authentication token to the authenticator API to validate session tokens and send refresh tokens. The API will also handle logic of its own, such as serving its content to the client front-end.
- ### Client Frontend
- This contains the code for the front-end that will be consumed by the primary account owner and the guest. It will have a login page and a page that requires a valid session token to access.
- ### Deploy
- This contains the files necessary to spin up a Docker instance of the project directory. It will create an instance of the authenticator API, two instances of the authenticator front-end (for the primary account user and guest user), two instances of the client front-end (for the primary account user and guest user), one instance of the client API, a PostgreSQL database, and a mail server (mailslurper).
- Use the following command to start the Docker project:
```(shell)
$ bash ./_up.sh
```
- Use the following command to tear down the Docker project (will also destroy any data in the database)
```(shell)
$ bash ./_down.sh
```
- When running, the services can be reached at the following URLs:
- Authenticator Backend - http://localhost:8000
- Mailslurper - http://localhost:8080
- Client Frontend - http://localhost:4200
- Copy of Frontend running on different port (to test CORS) - http://localhost:4201
- Any call made to the backend should fail due to CORS
# Accounts
The following accounts are scaffolded when the project is built out with Docker Compose:
- [email protected]
- [email protected]
- [email protected]
- [email protected]