isms
Information security management platform with git-native documents; needs PostgreSQL.
jailops app install ismsAdd --dry-run to see every step first. From the console: open Apps, pick isms and press Install; the dialog takes the jail name, the network and the storage, and Preview steps shows the plan before anything runs. See the console.
About
isms is an information security management system: policies, controls and evidence kept as git-native documents, collaboration through PostgreSQL, one binary with the web interface embedded. The package comes from the JailOps package repository and runs as the isms user with its data under /var/db/isms and its settings in /usr/local/etc/isms/server.env.
The installation does not configure or start it: isms needs a PostgreSQL database, which this app does not contain, and a master secret that only the operator should create. The notes list the steps; the postgresql app of this catalog provides the database.
What you get
Ports
8080/tcphttp exposeThe web interface and the API (UNVERIFIED port); put a TLS proxy in front.
Data on its own datasets
/var/db/ismsvolumevar-db-ismsThe per-organisation git repositories, file blobs, templates and the signing key.
Configuration
/usr/local/etc/isms/server.envKEY=VALUE settings with the database URL and the master secret; mode 0600, owner isms. Restart:service isms restart.
Logs
/var/log/isms.logWhat the program prints, written by daemon(8).
Health check
None: no service is started until you have configured it, so there is nothing to check yet.
Services
isms: enabled, not started
Setup, once, before the first start
Five commands, run in the jail as argv, without a shell:
/bin/mkdir -p /var/db/isms/private/usr/sbin/chown isms:isms /var/db/isms /var/db/isms/private /usr/local/etc/isms/server.env/bin/chmod 0750 /var/db/isms/bin/chmod 0700 /var/db/isms/private/bin/chmod 0600 /usr/local/etc/isms/server.env
After the installation
The notes of the definition, shown after the installation too.
isms is enabled but not started. Until server.env is complete, a restart of the jail starts it and it exits again every 5 seconds; /var/log/isms.log says why. Do these steps once (DB is a postgresql jail, ADDR this jail's address):
- In DB: jailops shell DB, then su -l postgres -c psql and run
CREATE ROLE isms LOGIN PASSWORDPW; CREATE DATABASE isms OWNER isms;
Set listen_addresses =*in postgresql.conf, add to pg_hba.conf
host isms isms ADDR/32 scram-sha-256 and run service postgresql restart. - In this jail (jailops shell NAME), edit /usr/local/etc/isms/server.env:
DATABASE_URL="postgres://isms:PW@DB_ADDRESS:5432/isms?sslmode=disable",
ISMS_BASE_URL (the https URL users open) and ISMS_SIGNING_EMAIL. - Set the master secret once and back it up; never change it later:
sed -i '' "s|^ISMS_SECRET=.*|ISMS_SECRET=$(openssl rand -hex 32)|" /usr/local/etc/isms/server.env - Create the signing key (your ISMS_SIGNING_EMAIL as the comment):
su -m isms -cssh-keygen -q -t ed25519 -N "" -C you@example.com -f /var/db/isms/private/isms_key - Apply the schema:
env ISMS_SERVER_ENV=/usr/local/etc/isms/server.env su -m isms -c/usr/local/bin/isms server migrate - service isms start
The web interface is on port 8080 (UNVERIFIED); serve it over https through the nginx app. A coming version wires apps together with jailops app allow (role, password and DATABASE_URL made for you); until then, these steps.
How it connects
jailops app allow isms from @web
This opens port 8080/tcp of this app to the jail web, and nothing else. The service itself must listen on the jail's address and accept the client.
Needs PostgreSQL
isms keeps its data in a PostgreSQL database, which this app does not contain. Install PostgreSQL in a jail of its own, then let this app in:
jailops app allow postgresql --from @isms --db ismsThe printed connection string goes into this app's configuration, as its notes say.
An installed app is closed: nothing reaches it, not even its own network, until you allow a source. A source is a jail (@web), a jail of another project (@project/web), an address set, an address or prefix, or host. jailops app access isms lists who may connect. The names here are jail names: jailops app install names the jail after the app unless --name says otherwise.