Mhttpd: Difference between revisions

From MidasWiki
Jump to navigation Jump to search
No edit summary
(The midas documentation has moved to https://midas.triumf.ca/docs/)
Tag: Replaced
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Pagelinks}}
The midas documentation has moved. The new documentation about the mhttpd web server is in:
= Links =
* [https://midas.triumf.ca/docs/develop/reference/reference/programs/#mhttpd mhttpd] on the Programs and options page (command-line options)
{{mhttpdpages3|[[Mhttpd.js|MIDAS Javascript Library]]|[[odbedit]]|[[Security]]}}
* [https://midas.triumf.ca/docs/develop/features/core_system/web/ Web interface: overview] (connecting and the built-in pages)
 
* [https://midas.triumf.ca/docs/develop/features/deployment/security/#web-security Web security] on the Security page (access from other computers, proxies and SSL)
 
= Purpose =
The {{Utility|name=mhttpd}} utility runs the '''MIDAS Web Server''' which allows the user to communicate with an experiment using any web browser. It is used primarily for run control.
 
= Web security =
 
For '''maximum web security''', {{Utility|name=mhttpd}} should be run behind a password-protected '''Apache/nginx HTTPS proxy''' (see [[Security]] for details).
 
By default (since March 2020) mhttpd binds to port 8080, <b>and accepts connections from localhost only</b>. This is ideal behaviour if you are behind an Apache/nginx proxy. You may change the port number by editing the ''localhost port'' ODB key in the [[Webserver ODB tree]].
 
To change the security model (e.g. to allow http/https connections from other machines), see the relevant keys in the [[Webserver ODB tree]].
 
= Arguments =
      -a add hostname to the hostlist of hosts allowed to connect to mhttpd
      -e experiment to connect to
      -h connect to midas server (mserver) on given host
      -v display verbose HTTP communication
      -D become a daemon
      -E only display ELog system
      -H only display history plots
      --verbose-mg - trace mongoose web requests
      --trace-mg - trace mongoose events
      --no-trace-mg-recv - do not trace mongoose recv events
      --no-trace-mg-send - dop not trace mongoose send events
      --no-multithread - disable mongoose multithreading
      --no-passwords - disable password protection
      --no-hostlist - disable access control host list
 
= Usage =
== To start the webserver ==
* ''"mhttpd"'' or
* ''"mhttpd -v"'' to get debug information, or
* ''"mhttpd -D"'' to run in the background
* ''"mhttpd -a myHost1 -a myHost2"'' to restrict web access
 
If you have enabled https connections in the [[Webserver ODB tree]], a password file (and optionally an SSL certificate) need to be created when {{Utility|name=mhttpd}} is started for the first time. See [[#HTTPS/SSL server (Mongoose)|mhttpd HTTPS/SSL server]] for more information.
 
=== Multiple experiments ===
If [[Exptab|multiple experiments]] run on the same host, a web server for each experiment must be started on a different port. Use the [[Webserver ODB tree]] in each experiment to specify which ports to use.
 
= Features =
The Midas web server {{Utility|name=mhttpd}} provides a means for run control including monitoring of the run parameters.
Its main feature is a web page invoked through any web browser accessing the Midas experimental URL at a defined port (see [[#Usage|Usage]]). 
 
The contents of this '''Midas status page''' is composed with minimal information relative to the experiment. It contains a collection of buttons and links to other pages to further describe and control the configuration of the experiment.
 
* Minimal display on the main [[Status Page]]
** Experiment name, time & date, page refresh rate
** Standard Menu Buttons (see below)
** User defined buttons (e.g. alias links, run scripts, custom pages etc.)
** run comments and condition display section (if enabled)
** Equipment list with current running condition, number of event received, event rate, data rate for each equipment.
** Data logging statistics (number of event recorded, data size recorder, compression factor, usage storage level) if enabled.
** Secondary Data logging (data mover) with statistics if enabled.
** Single line of the most recent Midas message.
** Table of the current applications connected to this experiment.
 
* Standard Menu Buttons
** Transition the state of the run (stopped/running/paused), allows user running condition parameters to be entered at the start state (see [[Edit-on-start Parameters]]).
** Access to the full [[Online Database]] for data display and/or data content modification.
** Display the [[Message Page]], which shows messages generated by the MIDAS [Message System]] as well as the user using cm_msg() functions.
** Access to [[ELOG Page]] switches to the predefined "electronic logbook".
** Access to the [[Alarms Page]] for monitoring the different type of alarms (evaluated, programs, internals, periodic).
** Access to the [[Programs Page]]  for a status or interaction with the current running applications part of the Midas experiment.
** Access to the [[History Page]] for graphical data representation of any ODB variables and acquired data.
** Access to the Midas Slow Control Bus devices [[MSCB Page]] connected to this experiment.
** Access to the [[Sequencer Page]] control/monitoring page for [[Sequencer]] i.e. interactive loading/saving/running of a run sequence based on any ODB parameters.
** Access to the [[Chat Page]] for communication between users on the same experiment.
** Access to the [[Help Page]] with short-cut to the Midas Help documentation resource and other information.
* Links
** links to all the listed equipments invoking a dedicated page for the display and possible control of the equipment parameters.
** link to the logger configuration (if present) for the data recording.
** link to the possible secondary logging configuration parameters (if present).
 
Other features include a JSON interface and Javascript library used for implementing interactive [[Custom Page|custom pages]] for MIDAS experiments.
 
As of March 2020, you may also [[/Webserver_ODB_tree#Proxy|use mhttpd as a proxy to other webservers]].
 
<br>
--------
<br>
 
 
 
= Enabling SSL (https) support =
 
{{Utility|name=mhttpd}} is built on the [[https://github.com/cesanta/mongoose|Mongoose embedded web server]], and by default it listens on port 8080 on localhost only. 
 
If you want to listen on a secure port, you must:
* Configure which ports to listen on in the [[Webserver ODB tree]]
* Build mhttpd with SSL support enabled
* Create an SSL certificate
* Create a password file
 
{{Utility|name=mhttpd}} with Mongoose requires an '''SSL Certificate''' and a '''password file'''.  Ideally, an SSL Certificate issued by a well-known authority trusted by your browser should be used.
 
The first time {{Utility|name=mhttpd}} is run, if it does not find an SSL Certificate, it will print instructions on how to [[#Create an SSL certificate|create a self-signed SSL Certificate]]. If it finds no existing password file, it will then print instructions on how to [[#Create a password file|create a password file]] (see below for examples).
 
== Build mhttpd with SSL support ==
 
SSL support is optional in mhttpd and is disabled by default! If you try to use an https port in mhttpd but do not have SSL support, the midas message log will show an error message like
 
[mhttpd,ERROR] [mhttpd.cxx:19180:mongoose_listen,ERROR] https port "8443" requested, but mhttpd compiled without MG_ENABLE_SSL
 
SSL support relies on the mbedtls package, which can be downloaded using a handy makefile shortcut. After downloading mbedtls, you must re-run "cmake" so that it will pick up the new mbedtls files and enable SSL support when compiling mhttpd:
 
cd $MIDASSYS
make mbedtls
cd build
cmake ..
# Look for the line like "-- MIDAS: Found MBEDTLS in /path/to/midas/mbedtls"
make install
 
== Create an SSL certificate ==
If mhttpd is configured to open an https connection, an SSL certificate is required. If needed, you may create a self-signed certificate by running {{Utility|name=mhttpd}}, and following the printed instructions:
[user@dasdevpc2 test]$ mhttpd
Web server will listen on ports "8080r,8443s"
[mhttpd,ERROR] [mhttpd.cxx:17086:mongoose,ERROR] cannot find SSL certificate file "/home/user/online/test/ssl_cert.pem"
[mhttpd,ERROR] [mhttpd.cxx:17087:mongoose,ERROR] please create SSL certificate file: openssl req -new -nodes -newkey rsa:2048
-sha256 -out  ssl_cert.csr -keyout ssl_cert.key; openssl x509 -req -days 365 -sha256 -in ssl_cert.csr -signkey ssl_cert.key
-out ssl_cert.pem; cat ssl_cert.key >> ssl_cert.pem
could not start the mongoose web server, see messages and midas.log, bye!
 
The certificate and key should be placed in one PEM file called ssl_cert.pem located in either MIDAS environment variables [[MIDAS environment variables#MIDAS_DIR|MIDAS_DIR]] or [[MIDAS environment variables#MIDASSYS|MIDASSYS]], and the permissions on the file should be 600  or only owner read/write.
[user@dasdevpc2 test] chmod 600 ssl_cert.pem
 
Note that web browsers give scary warnings to users about accepting connections to servers with self-signed certificates. It is much better to get a full certificate from [[https://letsencrypt.org/Let's Encrypt]] or another certificate authority.
 
== Create a password file ==
If mhttpd is configured to require passwords for access, you will need to create a password file using htdigest. Running mhttpd will tell you on the command-line (and in the midas message log) what you need to do.
 
[user@dasdevpc2 test]$ mhttpd
Web server will listen on ports "8080r,8443s"
Web server will use SSL certificate file "/home/user/online/test/ssl_cert.pem"
[mhttpd,ERROR] [mhttpd.cxx:17137:mongoose,ERROR] mongoose web server cannot find password file "/home/user/online/test/htpasswd.txt"
[mhttpd,ERROR] [mhttpd.cxx:17138:mongoose,ERROR] please create password file: htdigest -c /home/user/online/test/htpasswd.txt test midas
could not start the mongoose web server, see messages and midas.log, bye!
 
Each person who is to have access to the experiment should create their own username and password. The first user (e.g. mary) creates the password file e.g. htpasswd.txt
[user@dasdevpc2 test]$ htdigest -c /home/user/online/test/htpasswd.txt test mary
Adding password for mary in realm test.
New password:
Re-type new password:
[user@dasdevpc2 test]$ mhttpd
Web server will listen on ports "8080r,8443s"
Web server will use SSL certificate file "/home/user/online/test/ssl_cert.pem"
Web server will use authentication realm "test", password file "./htpasswd.txt"
 
Access to the [[#Features|''Midas status page'']] can be obtained by pointing a web browser to
https://myhost.mydomain:8443
The first time you connect you will be asked for a username and password.
Now that the password file has been created, subsequent users may create their own username and password in the same file by omitting "-c" argument in htdigest, e.g.
  htdigest  /home/user/online/test/htpasswd.txt test john
 
Web access can be restricted to certain hosts if desired (see [[#Web security]]).
Documentation for the version of mongoose included with MIDAS can be found at [http://ladd00.triumf.ca/~daqweb/doc/midas-devel/doc/mongoose/ Mongoose documentation].
 
For more information see [https://midas.triumf.ca/elog/Midas/1062 Elog note 1062]
 
 
== Older versions ==
 
=== Pre-March 2020 ===
 
For '''maximum web security''', {{Utility|name=mhttpd}} should be run behind a password-protected '''Apache/nginx HTTPS proxy''' (see [[Security]] for details).  {{Utility|name=mhttpd}} should be built with HTTPS and built-in passwords disabled, http access restricted to localhost (or the host of the httpd, if they are not the same).
 
Alternatively, mhttpd can be run with '''good web security''' using password-protected secure HTTPS connections. This is the default case, where mhttpd is explicitly linked with OpenSSL to provide secure HTTPS connections via the [https://github.com/cesanta/mongoose Mongoose] web server.  To connect to an experiment using {{Utility|name=mhttpd}}, a username and password are required.
 
==== Pre-March 2020 mhttpd Arguments ====
      -h connect to midas server [[mserver]] on given host
      -e experiment to connect to
      -v display verbose HTTP communication
      -D become a daemon
      -E only display ELog system
      -H only display history plots
      -a only allow access for specific host(s), several [-a Hostname] statements might be given (default list
                  in ODB at [[/Experiment ODB tree#mhttpd hosts subtree|/Experiment/security/mhttpd hosts/allowed hosts]])
      --http port - bind to specified HTTP port (default is ODB [[/Experiment ODB tree#midas http port|/Experiment/midas http port]])
      --https port - bind to specified HTTPS port (default is ODB [[/Experiment ODB tree#midas https port|/Experiment/midas https port]])
      -help display usage information
 
 
=== Much older ===
 
Documentation on older versions of mhttpd can be found at [[Old and Obsolete Versions]].
 
 
 
[[Category:Utilities]]
[[Category:Web server mhttpd]]
[[Category:Run control]]

Latest revision as of 22:01, 30 October 2026

The midas documentation has moved. The new documentation about the mhttpd web server is in:

Retrieved from "https://daq00.triumf.ca/MidasWiki/index.php?title=Mhttpd&oldid=3767"