https://github.com/urfdvw/password-keeper
A handy DIY off-line password management device based on Pi Pico and CircuitPython.
https://github.com/urfdvw/password-keeper
circuitpython password-manager pipico
Last synced: 3 months ago
JSON representation
A handy DIY off-line password management device based on Pi Pico and CircuitPython.
- Host: GitHub
- URL: https://github.com/urfdvw/password-keeper
- Owner: urfdvw
- License: gpl-3.0
- Created: 2022-01-06T16:46:24.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T02:02:37.000Z (over 2 years ago)
- Last Synced: 2025-02-12T21:34:31.285Z (5 months ago)
- Topics: circuitpython, password-manager, pipico
- Language: Jupyter Notebook
- Homepage: https://urfdvw.github.io/Password-Keeper/
- Size: 2.77 MB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[中文文档](READMEZH.md)
# Password Keeper
A handy DIY off-line password management device.
## Why
This DIY project is a USB password management device for people who
- hate auto-saving passwords on browsers
- use public computers or changes devices all the time
- are forced to set a different "strong" password every month (me)
- have a lot of super-long passwords, such as Github keys and SSH keys
- just want to try out another CircuitPython Project.
***Disclaimer**:
This project only contains an off-line microcontroller code and a static pure front-end page.
Your password data will not be stored or sent via the internet due to the effect of this project.
This project focus on user experiences.
In other words,
using this project cannot improve the security of your passwords.
The author of this project is not responsible for any possible loss or leak of your passwords or accounts.
Using the code in this repository means you accept this disclaimer, fully understand the code's functionality,
and will take all risks.*
## Based on
Hardware and modules
- Pi Pico
- I2C SSD1306 OLED screen
Languages and libraries
- CircuitPython 7.0.0
- displayio
- usb_hid
- touchio
- JavaScript
- Chrome File API
- Ace Editor
Techniques
- Finite state machines
- Vigenère cipher
## Additional resource
- For circuit and PCB, please check: https://oshwlab.com/urfdvw/password-keeper_copy_copy
## How to make
- Make the PCB and solder the components on to the PCB board
- Install CircuitPython on the Pi Pico
- Copy the code to the CIRCUITPY drive
- 3D print the case according to the case, and glue it to the back
### Example data
In newly made keeper device, the default data file `items.csv` contains some example data.
- master password is `0` (one digit string zero),
- password of the `i`th item is `password{i}`, where `{i}` is a placeholder.
## How to use
### Update data
- Connect your password keeper to your computer
- Open [Password Keeper Manager](https://urfdvw.github.io/Password-Keeper/) in browser
- Type in your master password
- If it is the first time you use it, the default master password is `0` (one digit string zero),
- Click on [Open] and open the `items.csv` file on your `CIRCUITPY` drive
- If your master password is wrong, the `Deciphered Text` is going to show wrong passwords
- Make changes to your account information in the `Deciphered Text` area, following csv formate
- If you need a new, you can click on [Random Password] button to generate a strong password.
- Click on [Save] to save changes
- ***It is suggested that you keep a backup of `items.csv` by [Save As], and store that ciphered data file in a safe place***
### Log in using the password keeper
- Connect the Password Keeper with the computer or phone with proper USB wire
- Type in Master password on your password keeper
- rotate to change characters
- right to add a new character
- left to delete the last character
- center to confirm
- Find out your account in the list
- rotate to scroll
- center to select
- up to go back
- In the account
- right to type in URL
- left to type in user name
- down to type in password
- up to go back
### Change Master Password
- With current Master Password, Open your ciphered data file `items.csv` in the [Password Keeper Manager](https://urfdvw.github.io/Password-Keeper/)
- Make sure you are seeing the correct passwords in the `Deciphered Text` area
- Change the Master Password in the manager
- Click on [Save] to save modifications
## How to extend
Software extension suggestion
- You can make your own mini App and list it in the menu
- Please see [Developer Memo](./memo.md) for details
Hardware extension suggestions
- You can use the touch ring on any of your own DIY projects
- The [driver code](./code/driver.py) can be used directly
- Check out the [Python Script](https://colab.research.google.com/github/urfdvw/Password-Keeper/blob/main/wheel%20design/draw%20wheel%20svg.ipynb) that generates the wheel pattern that can be imported to your PCB design.
---
# Happy Coding