Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 10693fa500d4406c362ef0703f25d5caea226728
commit10693fa500d4406c362ef0703f25d5caea226728[log] [tgz]
authorAsmitha Karunanithi <asmitk01@in.ibm.com>Mon Jul 27 02:27:49 2020 -0500
committerAsmitha Karunanithi <asmitk01@in.ibm.com>Wed Aug 05 04:28:46 2020 +0000
treebcc95b6882e906790a1c1f8bb61368ac4e4a46f7
parent5a7e877e5fd7da96022d3959fbfec84bfa3d0f7f [diff]
EventService : Send event for ConfigFile updation

The commit implements the sending of push style events to the IBM's management client
when a configFile is updated.

Tested-By:
    1. Create a subscription by passing "ResourceTypes" as ["IBMConfigFile"]
       POST -D headers.txt https://${bmc}/redfish/v1/EventService/Subscriptions
       -d '{"Destination" : "https://<host:port>,"ResourceTypes":["IBMConfigFile"],"Protocol":"Redfish"}'
    2. Update an existing ConfigFile
       PUT https://${bmc}/ibm/v1/Host/ConfigFiles/<filename> --data-binary "@<local_path>"
    3. Verify the event is generated and posted to the subscriber as the following example:

       bodydata: {
         "@odata.type":"#Event.v1_4_0.Event",
         "Events":[
           {
             "EventId":1,
             "EventTimestamp":"2020-06-26T08:40:04+00:00",
             "EventType":"ResourceChanged",
             "MemberId":0,
             "Message" :"One or more resource properties have changed.",
             "MessageArgs":null,
             "MessageId":"ResourceEvent.1.0.3.ResourceChanged",
             "OriginOfCondition":"/ibm/v1/Host/ConfigFiles/<filename>",
             "MessageSeverity":"OK"
           }
         ],
         "Id":1,
         "Name":"Event Log"
       }
    4. Verified the event is sent to the subscriber when the resourceType list is empty.
    5. Verified the client subscribes for other resource - not ConfigFile ; then
       the event is not sent to the subscriber.

Signed-off-by: Asmitha Karunanithi <asmitk01@in.ibm.com>
Change-Id: I785c2a5a6e4e721cf722e94693db3a832f69fa50
1 file changed
tree: bcc95b6882e906790a1c1f8bb61368ac4e4a46f7
  1. cmake/
  2. http/
  3. include/
  4. redfish-core/
  5. scripts/
  6. src/
  7. static/
  8. .clang-format
  9. .dockerignore
  10. .gitignore
  11. bmcweb.service.in
  12. bmcweb.socket
  13. build_x86.sh
  14. build_x86_docker.sh
  15. cmake-format.json
  16. CMakeLists.txt
  17. CMakeLists.txt.in
  18. config.h.in
  19. DEVELOPING.md
  20. Dockerfile
  21. Dockerfile.base
  22. JenkinsFile
  23. LICENCE
  24. MAINTAINERS
  25. pam-webserver
  26. README.md
  27. 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.