MyOwnPKI documentation Source on GitHub

Test the beta

The beta is the last stretch before version 1.0. Its releases are ordinary ones (0.9.0, 0.9.1 and so on): install.sh, the container tag latest and the Salt formula behave as for every release. What changes is the rule for the code: the feature set is frozen, and only fixes follow. Version 1.0.0 comes when no open finding is one that the maintainer rates a blocker. Your part is to try it and to say what broke.

What is frozen

Nothing new is added during the beta: no feature, page, setting, REST field or command. What is accepted are fixes, documentation, tests, security hardening that only narrows what is accepted, and dependency security updates. A wish is welcome and gets the label post-1.0; it is looked at after 1.0, not built before. The full rules are on the Contributing page.

Warning: A beta can still have defects that lose data or stop a start. Test on a machine you can throw away, or keep the production instance you have and install the beta next to it. If you do update an instance that matters, back it up first and copy the backup off the machine.

Install the beta

Use the newest 0.9.x release; the release notes say which one it is.

Afterwards, print the version, so you can say what you ran:

myownpki --version

The tester checklist

You do not need all of it. Every item you try helps, and so does the note “this item worked”: say it in the feedback form, with the version.

  1. Install with install.sh, run init, write down the passphrase, the recovery key and the checkpoint fingerprint, unseal, and create the first CA (Installation). Was anything unclear or in the wrong order?
  2. Issue a certificate by ACME with certbot, with lego and with Caddy (certbot, lego, Traefik and Caddy). Renew once.
  3. The agent on a Debian or Ubuntu host, from the package: Agents → Add host, approve the enrollment, check that the certificate is deployed and that Renew now works (Adding hosts).
  4. A backup and its check. Make a backup, then verify it with the fingerprint of the backup key that init or the first backup printed:

    runuser -u myownpki -- /usr/local/bin/myownpki backup verify /var/backups/myownpki/before-test --backup-key <fingerprint>
    
  5. A restore into an empty directory on another machine or in a scratch directory, then start, unseal and look at the certificates (Backup and restore).
  6. Update from 0.3.12. Install 0.3.12 first, issue a certificate, then update to the beta as the Upgrade page says. Do certificates, CRLs, agents and the audit log look the same afterwards? What did db status say before and after?
  7. The trust portal on a phone. Open the public address of the server on an iPhone or an Android phone, install the root from the page and open a site with a certificate of yours (The trust portal).
  8. The demo, if you have Docker (Demo).
  9. Break something on purpose: a wrong passphrase, a revoked certificate, a name the policy refuses, a stopped agent. Is the message clear?

Known limitations

These are known, and they are not defects to report again. They are the reason for the beta.

How to report

Use the forms on GitHub; they ask for what is needed to find the problem.

The maintainer reads every report and sorts it:

What it is What happens
Blocker: data lost or a start refused after an update, a restore that loses data, an old agent that stops working, a certificate issued outside policy fixed in the next 0.9.x at once; 1.0 waits
Major: a wrong result with a workaround, a broken page, a guide command that fails fixed in the next 0.9.x if small, otherwise listed as a known limitation of 1.0
Minor: text, layout, a mistake in the documentation fixed when cheap
Wish: a feature or a setting label post-1.0, not built in the beta

Never post these

An issue is public, and so is its history after you edit it. Never paste, attach or describe the content of:

Before you paste a log, read it once and search it. This finds the usual cases; it does not replace reading:

grep -nE 'mop_|mjt_|mjp_|otpauth://|PRIVATE KEY|passphrase|secret|token' myownpki.log

If you posted one by mistake, treat it as leaked: delete the text, and then change what it protected (revoke the token, change the passphrase with myownpki passphrase change; a leaked CA key means the CA is replaced). Deleting the post is not enough, because others may already have copied it.