Before you install
Use this checklist to prepare a new StoredSafe installation. The Provisioning Wizard asks for these items roughly in this order. If you have them ready, the installation can be done in one session.
People and physical access
Physical console access to the appliance (keyboard and screen), or out-of-band access such as IPMI. SSH is closed by default and should not be your only way in.
Rack space (1U), two power feeds for the redundant power supplies, and network cabling.
The people who will hold the dual-control YubiKeys below. The two console keys and the two escrow keys should be held by different people, for example the CIO and the CSO.
YubiKeys and removable media
Five YubiKeys, programmed in static mode:
2 YubiKeys for console login as the
storedsafeuser. Each key holds one half of the password. See Manage Service accounts.2 YubiKeys for the two halves of the key escrow passphrase. See Key Escrow Management.
1 YubiKey for the passphrase protecting the backup PGP key. See Manage PGP and SSH key pairs used by the backup process.
You also need:
A USB disk to export the backup PGP secret key and the escrow private key. The same disk can be used to bring files to the appliance (license, certificate, logotype).
Paper and a safe for the printed copy of the escrow key.
YubiKeys for the first StoredSafe users, if they will log in with YubiKey OTP.
Network
Hostname and FQDN for the appliance. Check that it exists in DNS (forward and reverse) before you order the certificate.
IP address and network (CIDR) for IPv4 and/or IPv6.
Default gateway for IPv4 and/or IPv6.
Static routes, if any (up to 10).
Bonding, if used (for example 802.3ad/LACP): which interfaces to use and the matching switch configuration. See Interface & IP (IPv4 and IPv6) settings.
DNS: up to 3 name servers, DNS domain and search domains. See DNS settings.
NTP servers, reachable on UDP/123, and the timezone. Correct time is required for TOTP, certificate validation and the audit log. See Time Settings.
Syslog servers: IP address, port, and transport (UDP, TCP or RELP). See Syslog Settings.
Firewall openings
All incoming traffic is denied by default. Decide which networks (CIDR, IPv4 or IPv6) may connect:
Service |
Port |
Needed for |
|---|---|---|
Web GUI / REST API |
443/TCP |
Always (80/TCP optional, redirect only) |
SSH |
22/TCP |
Optional, not recommended |
SNMPv3 |
161/UDP |
Monitoring (optional) |
RADIUS |
1812/UDP |
RADIUS module only |
RADIUS HA sync |
3306/TCP |
HA pair only |
Make sure your network allows outgoing traffic from the appliance to:
The backup server, over SSH on the port you choose
NTP (UDP/123) and DNS (UDP and TCP/53), if used
Syslog servers
OCSP responders and CRL distribution points, if mTLS is used
The SMTP relay, if used
https://api.yubicloud.com, if YubiKey OTP is validated against Yubico’s public YubiCloud. This must be direct access. HTTP proxies are not supported.
See Firewall Management.
Backup
Backups are mandatory. Prepare an SSH server to receive them:
Host (FQDN or IP address) and SSH port
User account and target directory
A way to add the appliance’s SSH public key to that account during the installation. The key pair is created on the appliance.
Also decide:
The backup schedule (every 1, 6, 12 or 24 hours)
How many days local backup copies are kept
Where the exported backup PGP secret key is stored offsite. If this key is lost, no backup encrypted with it can be restored.
See Backup Management.
Certificates
An X.509 server certificate for the appliance’s FQDN and its private key, as two separate PEM files. See Manage Web Server Settings.
For client certificate authentication (mTLS): the client CA certificate(s) and OCSP/CRL details. See mTLS Settings.
Two-factor authentication
Decide how YubiKey OTP is validated:
Local (Private YubiCloud): uses the YubiHSM in the appliance. You need
yubikeys.txtandyubikeys.txt.signfor the users’ YubiKeys.Public YubiCloud: requires outgoing access to
api.yubicloud.com, as described above.
Optionally, choose a TOTP issuer name (for example your company name) to show in users’ authenticator apps. See Manage 2-factor settings.
License and branding
The StoredSafe license file (
license.iniandlicense.ini.sign), delivered by StoredSafe. It must have UNIX line endings (LF). A file saved with Windows line endings will not validate. See StoredSafe License.Optional: your logotype in PNG format, preferably with a transparent background, and any custom CSS for the background. See Branding - Logotype.
First user and next steps
Name and email for the first StoredSafe administrator. This user is created in the browser with the system install script (
/install.php) during provisioning, and the script is disabled right after. See Enable or Disable System install script.A rough plan for the first users, their capabilities (Admin, Write, Read, Audit, UG List) and the first vaults.
Optional: a monitoring system that supports SNMPv3. See StoredSafe Metrics via SNMPv3.