Generating Keys

PrivMX Endpoint supports Wallet Import Format (WIF) keys by default and offers tools such as converting PEM keys (OpenSSL) and deterministic private key generation from any text, such as a user's password or a given file.

warning

Private keys should always be known only to their owners. Generate them client-side and don't save them anywhere. This practice ensures that only the rightful owner has access to their private keys, significantly reducing the risk of unauthorized access or theft.

You will find more about keys in key concepts section

Generating Keys for PrivMX

The PrivMX Bridge Docker repo contains helper scripts for generating keys. Clone it by running following script in your favorite terminal

 git clone https://github.com/simplito/privmx-bridge-docker

and go to created "privmx-bridge-docker" folder.

Scripts require active running PrivMX Bridge docker container. You can run it using:

./setup.sh

or if you already started created one earlier:

docker compose -f docker-compose.yaml up

You can generate Endpoint compatible key pair using following script.

./genKeyPair.sh

Generated keys will be displayed in your terminal. They aren't stored anywhere, so make sure to copy them.

In Windows environment you must use bash compatible terminal like WSL or Git Bash.

You must register public key in PrivMX Bridge first, before using it's matching private key in PrivMX Endpoint. To do this you can use context/addUserToContext PrivMX Bridge method.