Himiツ

A COMPSEC300 Password Manager Project

秘密 (himitsu)

Noun, Na-adjective (keiyodoshi), Noun which may take the genitive case particle 'no'

1. secret; secrecy; confidentiality; privacy​

Disclaimer

This password manager was made as part of the COMPSEC300 Course and should not be considered an attempt at making feature full password manager intended for everyday use.

Usage

Commands

The password manager is launched by running the executable from the terminal with a specific command as an argument.
There are currently three available commands:

• Create and open a new empty password database:

./himitsu create <filename>

• Open an existing password database:

./himitsu open <filename>

• Change the password of an existing password database:

./himitsu passwd <filename>

GUI

The commands 'create' and 'open' will open the password manager GUI. All actions related to managing the passwords inside a database are done through the GUI and they should be rather self-explanatory.

The GUI requires a browser to be available on the system the program is being ran on in order to open.

Installation

Precompiled

You can download one of the precompiled binaries from the 'Releases' section. There are currently two binaries provided:

• Binaries compiled on Windows 11
• Binaries compiled on Archlinux

To use binaries just extract the downloaded zip and run the executable from the commandline.

To get started, simply run the following command while in the program directory.

./himitsu create <filename>

Building from source

Building the program from source should be easy and painless.

1. Clone the repo

git clone https://github.com/k-um-i/himitsu.git

2. Open the cloned folder

cd himitsu

3. Install the go-webui dependency by following their instructions
   https://github.com/webui-dev/go-webui
   (Specifically the As Go module section.)

4. Build the program

• Linux:

go build -o himitsu main.go

• Windows:

go build -o himitsu.exe main.go

Possible issues with building

Requirements

First of all make sure you have golang installed.
Note that compiling the program also requires a C-compiler since go-webui utilizes CGO.
The go-webui dependency must be installed separately as mentioned since go cannot automatically handle it correctly when building.

invalid go version '1.24.1'

If you run into the invalid go version '1.24.1': must match format 1.23 error when compiling, you can circumvent this error by manually modifying the 'go.mod' file in the project directory.
Manually change the go version inside go.mod from 1.24.1 to 1.24
"go 1.24.1" -> "go 1.24"