Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / e9a14131650d30389eaf9dc38a3c32f1cb552f52
commite9a14131650d30389eaf9dc38a3c32f1cb552f52[log] [tgz]
authorAppaRao Puli <apparao.puli@linux.intel.com>Thu Apr 09 22:09:03 2020 +0530
committerAppaRao Puli <apparao.puli@linux.intel.com>Fri May 08 18:39:25 2020 +0000
tree8bab9408296cb83cc802e72b5f59da9f201f264b
parentc9bb6861cd1bac2e1849b09176564f01c185207c [diff]
EventService: Add event log support with inotify

Add event logs support
 - Event log monitor by adding inotify on redfish log file.
 - Read event logs from "/var/log/redfish" file.
 - Filter the event logs using configured settings.
 - Format the event log data as per Events schema.
 - Send event log information to subcribed client.

Tested:
 - Added new event log subscription with filters
   and verified the event logs on event listener.
 - Ran redfish validater successfully.
 - Disabled BMCWEB_ENABLE_REDFISH_DBUS_LOG_ENTRIES
   and build successful.

   Event on listener looks as below:
{
   "@odata.type":"#Event.v1_4_0.Event",
   "Events":[
      {
         "Context":"CustomText",
         "EventId":"94787",
         "EventTimestamp":"1970-01-02T02:19:47+00:00",
         "EventType":"Event",
         "Message":"Memory ThermTrip asserted: .",
         "MessageArgs":[
            ""
         ],
         "MessageId":"OpenBMC.0.1.MemoryThermTrip",
         "Severity":"Critical"
      }
   ],
   "Id":"3",
   "Name":"Event Log"
}

Change-Id: Ie87322ff59f9f7caa26fb18d2e3b8d7af77ec540
Signed-off-by: AppaRao Puli <apparao.puli@linux.intel.com>
2 files changed
tree: 8bab9408296cb83cc802e72b5f59da9f201f264b
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .gitignore
  10. bmcweb.service.in
  11. bmcweb.socket
  12. build_x86.sh
  13. cmake-format.json
  14. CMakeLists.txt
  15. CMakeLists.txt.in
  16. config.h.in
  17. DEVELOPING.md
  18. JenkinsFile
  19. LICENCE
  20. MAINTAINERS
  21. pam-webserver
  22. README.md
  23. Redfish.md
README.md

OpenBMC webserver

This component attempts to be a "do everything" embedded webserver for openbmc.

Capabilities

At this time, the webserver implements a few interfaces:

  • Authentication middleware that supports cookie and token based authentication, as well as CSRF prevention backed by linux PAM authentication credentials.
  • An (incomplete) attempt at replicating phosphor-dbus-rest interfaces in C++. Right now, a few of the endpoint definitions work as expected, but there is still a lot of work to be done. The portions of the interface that are functional are designed to work correctly for phosphor-webui, but may not yet be complete.
  • Replication of the rest-dbus backend interfaces to allow bmc debug to logged in users.
  • An initial attempt at a read-only redfish interface. Currently the redfish interface targets ServiceRoot, SessionService, AccountService, Roles, and ManagersService. Some functionality here has been shimmed to make development possible. For example, there exists only a single user role.
  • SSL key generation at runtime. See the configuration section for details.
  • Static file hosting. Currently, static files are hosted from the fixed location at /usr/share/www. This is intended to allow loose coupling with yocto projects, and allow overriding static files at build time.
  • Dbus-monitor over websocket. A generic endpoint that allows UIs to open a websocket and register for notification of events to avoid polling in single page applications. (this interface may be modified in the future due to security concerns.

Configuration

BMCWeb is configured by setting -D flags that correspond to options in bmcweb/CMakeLists.txt and then compiling. For example, cmake -DBMCWEB_ENABLE_KVM=NO ... followed by make. The option names become C++ preprocessor symbols that control which code is compiled into the program.

When BMCWeb starts running, it reads persistent configuration data (such as UUID and session data) from a local file. If this is not usable, it generates a new configuration.

When BMCWeb SSL support is enabled and a usable certificate is not found, it will generate a self-sign a certificate before launching the server. The keys are generated by the secp384r1 algorithm. The certificate

  • is issued by C=US, O=OpenBMC, CN=testhost,
  • is valid for 10 years,
  • has a random serial number, and
  • is signed using the SHA-256 algorithm.