Files

Swordsteel 614abcb272 add redis and cleanup

- add doc/global_settings.md
- docker_database.md
- update dependency.md
- extrack hlaeja from  development-compose.yml to hlaeja-compose.yml
- rename compose.yml to development-compose.yml
- extract text from readme.md
  - databases to doc/docker_database.md
  - hlaeja service to doc/docker_hlaeja.md
- move and rename structure.md to doc/dependency.md
- move and rename identity.md to doc/rsa_key.mk
- move and rename certificate.md to doc/keystore.md

2024-12-27 23:44:50 +01:00

2.1 KiB

Raw Blame History

Generate Keystore

Generate Keystores

To generate a keystore for our API's and web manager, which is used to enable HTTPS, you can use the following command:

keytool -genkeypair -alias <service> -keyalg RSA -keysize 2048 -validity 3650 -dname "CN=<domain>" -keypass <password> -keystore ./cert/<keystore>.p12 -storetype PKCS12 -storepass <password>

This command generates a keystore with the following properties:

<service>: The alias for the service (e.g. device-api)
<domain>: The domain name for the service (e.g. deviceapi)
<password>: The password for the keystore and private key
./cert/<keystore>.p12: The file path and name for the generated keystore

Export the public certificate

Once you have generated a keystore, you can export the public certificate using the following command:

keytool -export -alias <service> -keystore ./cert/<keystore>.p12 -storepass <password> -file ./cert/<domain>.cer -rfc

This command exports the public certificate with the following properties:

<service>: The alias for the service (e.g. device-api)
<keystore>: The keystore file containing the private key and certificate (e.g. ./cert/deviceapi.p12)
<password>: The password for the keystore
<domain>: The domain name for the exported certificate file (e.g. deviceapi.cer)
./cert/<domain>.cer: The file path and name for the exported public certificate

The exported public certificate is then used on devices to establish a secure connection to our API. Specifically, the certificate is installed on devices to enable them to trust our API's SSL/TLS connection, allowing for encrypted communication between the device and our API.

Note: Make sure to update your hosts file with an entry for the domain name (e.g. 127.0.0.1 deviceapi) to enable local development.

Open hosts file:
- On Unix-like systems (Linux, macOS), this directory is typically /etc/hosts.
- On Windows, this directory is typically %SystemRoot%\System32\drivers\etc\hosts.

Add the following lines to the hosts file:

127.0.0.1	deviceapi		# Hlæja Device API

2.1 KiB Raw Blame History

Generate Keystore

Generate Keystores

Export the public certificate

2.1 KiB

Raw Blame History