commit	4dcc3f92c8725e2424c7792908c44311e484a429	[log] [tgz]
author	Suryakanth Sekar <suryakanth.sekar@linux.intel.com>	Tue Nov 26 22:40:15 2019 +0530
committer	Suryakanth Sekar <suryakanth.sekar@linux.intel.com>	Tue Dec 10 04:57:55 2019 +0000
tree	a92cbb00d926cea859bff5bdef76620051813123
parent	b4b9595ad8d679f2f5e83bd75d9b0902620fb1f5 [diff]

bmcweb: Message entry for At-Scale Debug Event

Message entry for
1. At-Scale Debug session established and closed.
2. Whenever At-Scale Debug user is enabled or disabled
3. At-scalde Debug feature is enabled or disabled in platform
4. At-sclde Debug service is enabled or disabled

Tested:
1. Ran Redfish validator - passed for this new addition.

Log will be shown as below:

       {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/254",
            "@odata.type": "#LogEntry.v1_4_0.LogEntry",
            "Created": "1970-01-01T00:04:14+00:00",
            "EntryType": "Event",
            "Id": "254",
            "Message": "At-Scale Debug Feature is enabled in hardware.",
            "MessageArgs": [],
            "MessageId": "OpenBMC.0.1.AtScaleDebugFeatureEnabledAtHardware",
            "Name": "System Event Log Entry",
            "Severity": "Critical"
        },
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/254_1",
            "@odata.type": "#LogEntry.v1_4_0.LogEntry",
            "Created": "1970-01-01T00:04:14+00:00",
            "EntryType": "Event",
            "Id": "254_1",
            "Message": "At-Scale Debug service is started.",
            "MessageArgs": [],
            "MessageId": "OpenBMC.0.1.AtScaleDebugFeatureEnabled",
            "Name": "System Event Log Entry",
            "Severity": "Critical"
        },
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/30630_2",
            "@odata.type": "#LogEntry.v1_4_0.LogEntry",
            "Created": "1970-01-01T08:30:30+00:00",
            "EntryType": "Event",
            "Id": "30630_2",
            "Message": "At-scale-debug service is now connected 198.164.11.12",
            "MessageArgs": [
                "198.164.11.12"
            ],
            "MessageId": "OpenBMC.0.1.AtScaleDebugConnected",
            "Name": "System Event Log Entry",
            "Severity": "Critical"
        },
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/30630_3",
            "@odata.type": "#LogEntry.v1_4_0.LogEntry",
            "Created": "1970-01-01T08:30:30+00:00",
            "EntryType": "Event",
            "Id": "30630_3",
            "Message": "At-scale-debug connection aborted/failed",
            "MessageArgs": [],
            "MessageId": "OpenBMC.0.1.AtScaleDebugConnectionFailed",
            "Name": "System Event Log Entry",
            "Severity": "Critical"
        },
       {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/30629_2",
            "@odata.type": "#LogEntry.v1_4_0.LogEntry",
            "Created": "1970-01-01T08:30:29+00:00",
            "EntryType": "Event",
            "Id": "30629_2",
            "Message": "At-scale-debug service is now disconnected",
            "MessageArgs": [],
            "MessageId": "OpenBMC.0.1.AtScaleDebugDisconnected",
            "Name": "System Event Log Entry",
            "Severity": "OK"
        },
        {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/262",
            "@odata.type": "#LogEntry.v1_4_0.LogEntry",
            "Created": "1970-01-01T00:04:22+00:00",
            "EntryType": "Event",
            "Id": "262",
            "Message": "At-Scale Debug special user is disabled",
            "MessageArgs": [],
            "MessageId": "OpenBMC.0.1.AtScaleDebugSpecialUserDisabled",
            "Name": "System Event Log Entry",
            "Severity": "OK"
        },
       {
            "@odata.context": "/redfish/v1/$metadata#LogEntry.LogEntry",
            "@odata.id": "/redfish/v1/Systems/system/LogServices/EventLog/Entries/154",
            "@odata.type": "#LogEntry.v1_4_0.LogEntry",
            "Created": "1970-01-01T00:02:34+00:00",
            "EntryType": "Event",
            "Id": "154",
            "Message": "At-Scale Debug special user is enabled",
            "MessageArgs": [],
            "MessageId": "OpenBMC.0.1.AtScaleDebugSpecialUserEnabled",
            "Name": "System Event Log Entry",
            "Severity": "Critical"
        },

Signed-off-by: Suryakanth Sekar <suryakanth.sekar@linux.intel.com>
Change-Id: Id5369c36547c4a5d7ae6f1f1dbd4dae8317a26d7

redfish-core/include/registries/openbmc_message_registry.hpp[diff]

1 file changed

tree: a92cbb00d926cea859bff5bdef76620051813123

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 prime256v1 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.