| Manojkiran Eda | af6298d | 2020-05-27 08:51:32 +0530 | [diff] [blame] | 1 | option('yocto-deps', type: 'feature', value: 'disabled', description : 'Use YOCTO dependencies system') |
| 2 | option('kvm', type : 'feature',value : 'enabled', description : 'Enable the KVM host video WebSocket. Path is \'/kvm/0\'. Video is from the BMC\'s \'/dev/video\' device.') |
| 3 | option ('tests', type : 'feature', value : 'enabled', description : 'Enable Unit tests for bmcweb') |
| 4 | option('vm-websocket', type : 'feature', value : 'enabled', description : '''Enable the Virtual Media WebSocket. Path is \'/vm/0/0\'to open the websocket. See https://github.com/openbmc/jsnbd/blob/master/README.''') |
| Ed Tanous | efb8062 | 2021-02-20 11:04:01 -0800 | [diff] [blame] | 5 | |
| 6 | # if you use this option and are seeing this comment, please comment here: |
| 7 | # https://github.com/openbmc/bmcweb/issues/188 and put forward your intentions |
| 8 | # for this code. At this point, no daemon has been upstreamed that implements |
| 9 | # this interface, so for the moment this appears to be dead code; In leiu of |
| 10 | # removing it, it has been disabled to try to give those that use it the |
| 11 | # opportunity to upstream their backend implementation |
| 12 | #option('vm-nbdproxy', type: 'feature', value : 'disabled', description : 'Enable the Virtual Media WebSocket.') |
| James Feist | 47c9e10 | 2020-02-12 13:05:07 -0800 | [diff] [blame] | 13 | option('rest', type : 'feature', value : 'disabled', description : '''Enable Phosphor REST (D-Bus) APIs. Paths directly map Phosphor D-Bus object paths, for example, \'/xyz/openbmc_project/logging/entry/enumerate\'. See https://github.com/openbmc/docs/blob/master/rest-api.md.''') |
| Manojkiran Eda | af6298d | 2020-05-27 08:51:32 +0530 | [diff] [blame] | 14 | option('redfish', type : 'feature',value : 'enabled', description: 'Enable Redfish APIs. Paths are under \'/redfish/v1/\'. See https://github.com/openbmc/bmcweb/blob/master/DEVELOPING.md#redfish.') |
| 15 | option('host-serial-socket', type : 'feature', value : 'enabled', description : 'Enable host serial console WebSocket. Path is \'/console0\'. See https://github.com/openbmc/docs/blob/master/console.md.') |
| 16 | option('static-hosting', type : 'feature', value : 'enabled', description : 'Enable serving files from the \'/usr/share/www\' directory as paths under \'/\'.') |
| 17 | option('redfish-bmc-journal', type : 'feature', value : 'disabled', description : 'Enable BMC journal access through Redfish. Paths are under \'/redfish/v1/Managers/bmc/LogServices/Journal\'.') |
| Manojkiran Eda | af6298d | 2020-05-27 08:51:32 +0530 | [diff] [blame] | 18 | option('redfish-cpu-log', type : 'feature', value : 'disabled', description : '''Enable CPU log service transactions through Redfish. Paths are under \'/redfish/v1/Systems/system/LogServices/Crashdump'.''') |
| Ravi Teja | 3fad0d5 | 2020-10-16 11:18:02 -0500 | [diff] [blame] | 19 | option('redfish-dump-log', type : 'feature', value : 'disabled', description : 'Enable Dump log service transactions through Redfish. Paths are under \'/redfish/v1/Systems/system/LogServices/Dump\'and \'/redfish/v1/Managers/bmc/LogServices/Dump\'') |
| Manojkiran Eda | af6298d | 2020-05-27 08:51:32 +0530 | [diff] [blame] | 20 | option('redfish-dbus-log', type : 'feature', value : 'disabled', description : 'Enable DBUS log service transactions through Redfish. Paths are under \'/redfish/v1/Systems/system/LogServices/EventLog/Entries\'') |
| Spencer Ku | b7028eb | 2021-10-26 15:27:35 +0800 | [diff] [blame] | 21 | option('redfish-host-logger', type : 'feature', value : 'enabled', description : 'Enable host log service transactions based on phosphor-hostlogger through Redfish. Paths are under \'/redfish/v1/Systems/system/LogServices/HostLogger\'') |
| Manojkiran Eda | af6298d | 2020-05-27 08:51:32 +0530 | [diff] [blame] | 22 | option('redfish-provisioning-feature', type : 'feature', value : 'disabled', description : 'Enable provisioning feature support in redfish. Paths are under \'/redfish/v1/Systems/system/\'') |
| 23 | option('bmcweb-logging', type : 'feature', value : 'disabled', description : 'Enable output the extended debug logs') |
| Alan Kuo | f16f626 | 2020-12-08 19:29:59 +0800 | [diff] [blame] | 24 | option('basic-auth', type : 'feature', value : 'enabled', description : '''Enable basic authentication''') |
| 25 | option('session-auth', type : 'feature', value : 'enabled', description : '''Enable session authentication''') |
| 26 | option('xtoken-auth', type : 'feature', value : 'enabled', description : '''Enable xtoken authentication''') |
| 27 | option('cookie-auth', type : 'feature', value : 'enabled', description : '''Enable cookie authentication''') |
| Manojkiran Eda | af6298d | 2020-05-27 08:51:32 +0530 | [diff] [blame] | 28 | option('mutual-tls-auth', type : 'feature', value : 'enabled', description : '''Enables authenticating users through TLS client certificates. The insecure-disable-ssl must be disabled for this option to take effect.''') |
| 29 | option('ibm-management-console', type : 'feature', value : 'disabled', description : 'Enable the IBM management console specific functionality. Paths are under \'/ibm/v1/\'') |
| Feras Aldahlawi | 735ef6d | 2021-03-19 14:01:46 -0700 | [diff] [blame] | 30 | option('google-api', type : 'feature', value : 'disabled', description : 'Enable the Google specific functionality. Paths are under \'/google/v1/\'') |
| Ed Tanous | b9c0b58 | 2020-10-07 11:57:19 -0700 | [diff] [blame] | 31 | option('http-body-limit', type: 'integer', min : 0, max : 512, value : 30, description : 'Specifies the http request body length limit') |
| George Liu | e820493 | 2021-02-01 14:42:49 +0800 | [diff] [blame] | 32 | option('redfish-new-powersubsystem-thermalsubsystem', type : 'feature', value : 'disabled', description : 'Enable/disable the new PowerSubsystem, ThermalSubsystem, and all children schemas. This includes displaying all sensors in the SensorCollection. At a later date, this feature will be defaulted to enabled.') |
| zhanghch05 | 0256b69 | 2021-06-12 10:26:52 +0800 | [diff] [blame] | 33 | option('redfish-allow-deprecated-power-thermal', type : 'feature', value : 'enabled', description : 'Enable/disable the old Power / Thermal. The default condition is allowing the old Power / Thermal.') |
| Vivekanand Veeracholan | 54d1355 | 2021-06-14 19:16:36 -0700 | [diff] [blame] | 34 | option ('https_port', type : 'integer', min : 1, max : 65535, value : 443, description : 'HTTPS Port number.') |
| Manojkiran Eda | af6298d | 2020-05-27 08:51:32 +0530 | [diff] [blame] | 35 | |
| 36 | # Insecure options. Every option that starts with a `insecure` flag should |
| 37 | # not be enabled by default for any platform, unless the author fully comprehends |
| 38 | # the implications of doing so.In general, enabling these options will cause security |
| 39 | # problems of varying degrees |
| 40 | |
| 41 | option ('insecure-disable-csrf', type : 'feature', value : 'disabled', description : 'Disable CSRF prevention checks.Should be set to false for production systems.') |
| 42 | option ('insecure-disable-ssl', type : 'feature', value : 'disabled', description : 'Disable SSL ports. Should be set to false for production systems.') |
| 43 | option ('insecure-disable-auth', type : 'feature', value : 'disabled', description : 'Disable authentication on all ports. Should be set to false for production systems') |
| 44 | option ('insecure-disable-xss', type : 'feature', value : 'disabled', description : 'Disable XSS preventions') |
| 45 | option ('insecure-tftp-update', type : 'feature', value : 'disabled', description : '''Enable TFTP based firmware update transactions through Redfish UpdateService.SimpleUpdate.''') |
| 46 | option ('insecure-push-style-notification',type : 'feature', value : 'disabled', description : 'Enable HTTP push style eventing feature') |
| Ed Tanous | 5e52870 | 2022-04-26 10:20:25 -0700 | [diff] [blame] | 47 | option ('insecure-enable-redfish-query', type : 'feature', value : 'disabled', description : 'Enables Redfish expand query parameter. This feature is experimental, and has not been tested against the full limits of user-facing behavior. It is not recommended to enable on production systems at this time. Other query parameters such as only are not controlled by this option.') |