Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-certificate-manager / aa19f3175cf8ae72cfeec81f7eae8d689498c017
commitaa19f3175cf8ae72cfeec81f7eae8d689498c017[log] [tgz]
authorNan Zhou <nanzhoumails@gmail.com>Thu Mar 17 14:45:10 2022 -0700
committerNan Zhou <nanzhoumails@gmail.com>Mon Mar 21 19:21:10 2022 +0000
tree438d53a45b317cd205570c67a069f159d642cf52
parent9c222dfdd1dc512ae4c93d9e764d8be9cf17b92d [diff]
OWNERS: add Nan Zhou as an owner

I have done a serials of refactoring in this repo to improve readability
and codes health, and solve bugs, for example, a non-trivial one,
https://gerrit.openbmc-project.xyz/c/openbmc/phosphor-certificate-manager/+/50010

I also did a design review in the certificate management topic, and
implemented the design,
https://gerrit.openbmc-project.xyz/c/openbmc/docs/+/49317.

Thus, I apply to be a maintainer of this repo. Hope I can contribute
more and help the OpenBMC community.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: I29c76d336e6d0a19516dfc01f018f3b9ca07e915
1 file changed
tree: 438d53a45b317cd205570c67a069f159d642cf52
  1. bmc-vmi-ca/
  2. dist/
  3. subprojects/
  4. test/
  5. .clang-format
  6. .gitignore
  7. .lcovrc
  8. argument.cpp
  9. argument.hpp
  10. certificate.cpp
  11. certificate.hpp
  12. certs_manager.cpp
  13. certs_manager.hpp
  14. config.h.in
  15. csr.cpp
  16. csr.hpp
  17. LICENSE
  18. mainapp.cpp
  19. meson.build
  20. meson_options.txt
  21. OWNERS
  22. README.md
  23. watch.cpp
  24. watch.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.