Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-certificate-manager / fd3ad1b0c7578b19be9d4b33403264392d994641
commitfd3ad1b0c7578b19be9d4b33403264392d994641[log] [tgz]
authorNan Zhou <nanzhoumails@gmail.com>Fri Sep 16 03:53:32 2022 +0000
committerNan Zhou <nanzhoumails@gmail.com>Mon Sep 19 22:40:16 2022 +0000
tree0d0e8a96c73d7c1fddf76a1556aa5937774e053c
parent49841d6e19279a50ee9d73880babdb248be0e982 [diff]
lcov: remove the configure file

The file was created when this repo is using autotools. In meson repos,
I don't see this file in other repos.

I also searched the default lcov configurations [1]; the values in this
file are default values. I don't see it's neccessary to keep this file
in this project.

[1] https://www.systutorials.com/docs/linux/man/5-lcovrc/

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: Ife2fa3f01337db7ce11ac582fcd9fd6b40fe29a6
1 file changed
tree: 0d0e8a96c73d7c1fddf76a1556aa5937774e053c
  1. bmc-vmi-ca/
  2. dist/
  3. subprojects/
  4. test/
  5. .clang-format
  6. .gitignore
  7. .openbmc-enforce-gitlint
  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
  25. x509_utils.cpp
  26. 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.