openbmc/phosphor-certificate-manager/README.md

1 # phosphor-certificate-manager
3 Certificate management allows to replace the existing certificate and private
5 management allows the user to install both the server and client certificates.
10 `meson builddir && ninja -C builddir`.
14 Multiple instances of `phosphor-certificate-manager` are usually run on the bmc
15 to support management of different types of certificates.
18 Usage: ./phosphor-certificate-manager [options]
20     --help            Print this menu
21     --type            certificate type
23     --endpoint        d-bus endpoint
24     --path            certificate file path
25     --unit=<name>     Optional systemd unit need to reload
28 ### Https certificate management
33 ./phosphor-certificate-manager --type=server --endpoint=https \
34     --path=/etc/ssl/certs/https/server.pem --unit=bmcweb.service
37 ### CA certificate management
42 ./phosphor-certificate-manager --type=authority --endpoint=truststore \
43     --path=/etc/ssl/certs/authority --unit=bmcweb.service
46 ### LDAP client certificate management
51 ./phosphor-certificate-manager --type=client --endpoint=ldap \
52     --path=/etc/nslcd/certs/cert.pem
55 ## D-Bus Interface
57 `phosphor-certificate-manager` is an implementation of the D-Bus interface
59 [this document](https://github.com/openbmc/phosphor-dbus-interfaces/blob/a3d0c212a1e734a77fbaf11c75…
61 D-Bus service name is constructed by
62 "xyz.openbmc_project.Certs.Manager.{Type}.{Endpoint}" and D-Bus object path is
65 Take https certificate management as an example.
68 ./phosphor-certificate-manager --type=server --endpoint=https \
69     --path=/etc/ssl/certs/https/server.pem --unit=bmcweb.service
72 D-Bus service name is "xyz.openbmc_project.Certs.Manager.Server.Https" and D-Bus
78 [REST APIs](https://github.com/openbmc/bmcweb/blob/master/redfish-core/lib/certificate_service.hpp)
79 for certificate management on the BMC, which leverages functionalities of
80 `phosphor-certificate-manager` via D-Bus.