Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-certificate-manager / 16b6c358a3bcdc98c9f9412a9f72785929a26cc0
commit16b6c358a3bcdc98c9f9412a9f72785929a26cc0[log] [tgz]
authorPatrick Williams <patrick@stwcx.xyz>Thu Dec 08 10:54:14 2022 -0600
committerPatrick Williams <patrick@stwcx.xyz>Thu Dec 08 10:54:14 2022 -0600
tree3e3e83d6fd5cacda97450a5fa2d5c2c332802cf4
parent0aea216914c5de2bb428281d9c0405161eb06439 [diff]
markdownlint: fix all warnings

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I0f8f7fbc23cb0113c093cad8a7d722054eac960a
1 file changed
tree: 3e3e83d6fd5cacda97450a5fa2d5c2c332802cf4
  1. bmc-vmi-ca/
  2. dist/
  3. subprojects/
  4. test/
  5. .clang-format
  6. .clang-tidy
  7. .gitignore
  8. .openbmc-enforce-gitlint
  9. argument.cpp
  10. argument.hpp
  11. certificate.cpp
  12. certificate.hpp
  13. certs_manager.cpp
  14. certs_manager.hpp
  15. config.h.in
  16. csr.cpp
  17. csr.hpp
  18. LICENSE
  19. mainapp.cpp
  20. meson.build
  21. meson_options.txt
  22. OWNERS
  23. README.md
  24. watch.cpp
  25. watch.hpp
  26. x509_utils.cpp
  27. x509_utils.hpp
README.md

phosphor-certificate-manager

Certificate management allows to replace the existing certificate and private key file with another (possibly CA signed) Certificate key file. Certificate management allows the user to install both the server and client certificates.

To Build

This project can be built with meson. The typical meson workflow is: meson builddir && ninja -C builddir.

To Run

Multiple instances of phosphor-certificate-manager are usually run on the bmc to support management of different types of certificates.

Usage: ./phosphor-certificate-manager [options]
Options:
    --help            Print this menu
    --type            certificate type
                      Valid types: client,server,authority
    --endpoint        d-bus endpoint
    --path            certificate file path
    --unit=<name>     Optional systemd unit need to reload

Https certificate management

Purpose: Server https certificate

./phosphor-certificate-manager --type=server --endpoint=https \
    --path=/etc/ssl/certs/https/server.pem --unit=bmcweb.service

CA certificate management

Purpose: Client certificate validation

./phosphor-certificate-manager --type=authority --endpoint=ldap \
    --path=/etc/ssl/certs/authority --unit=bmcweb.service

LDAP client certificate management

Purpose: LDAP client certificate validation

./phosphor-certificate-manager --type=client --endpoint=ldap \
    --path=/etc/nslcd/certs/cert.pem

D-Bus Interface

phosphor-certificate-manager is an implementation of the D-Bus interface defined in this document.

D-Bus service name is constructed by "xyz.openbmc_project.Certs.Manager.{Type}.{Endpoint}" and D-Bus object path is constructed by "/xyz/openbmc_project/certs/{type}/{endpoint}".

Take https certificate management as an example.

./phosphor-certificate-manager --type=server --endpoint=https \
    --path=/etc/ssl/certs/https/server.pem --unit=bmcweb.service

D-Bus service name is "xyz.openbmc_project.Certs.Manager.Server.Https" and D-Bus object path is "/xyz/openbmc_project/certs/server/https".

Usage in openbmc/bmcweb

OpenBMC bmcweb exposes various REST APIs for certificate management on the BMC, which leverages functionalities of phosphor-certificate-manager via D-Bus.