search

uhppoted / uhppoted-httpd

Browser based user interface for an access control system based on the UHPPOTE TCP/IP controllers
Other
4 stars 1 forks source link

readme

build build

uhppoted-httpd

uhppoted-httpd implements an HTTP server that provides a browser based user interface for managing an access control system based on UHPPOTE TCP/IP controllers. It is intended to supplement the existing command line tools and application integrations.

SECURITY NOTICE

Versions _v0.8.8 and earlier have a bug in the authentication logic that allows a deleted user to log in unless the system has been restarted. This has been fixed in:

  1. If you're running uhppoted-httpd as a console application, please either

    • Restart uhppoted-httpd
    • Clone the repository and build an updated version with the fix

  2. If you're running uhppoted-httpd as a service/daemon, please either

    • Restart the uhppoted-httpd service/daemon
    • Clone the repository and build an updated version with the fix

  3. If you're running a Docker image, please update to the latest version on ghcr.io

Status

Supported operating systems:

Raison d'être

CAVEAT EMPTOR

  1. Although uhppoted-httpd does provide a functional and usable user interface for managing a small'ish access control system, the out-of-the-box look and feel is (deliberately) workaday, low key and plain with the intention of being a base for your own customisation (with your own logos, themes, functionality, etc) rather than a finished, shippable product.

  2. Also, please be aware that at this stage in its career, it is primarily a testbed for validating the design and implementation of the other uhppoted components when integrated into a working system. It is also intended to become a platform for exploring some alternative ideas around user interfaces and system architectures.

  3. It is intended as an adminstrative tool for use by system administrators (i.e. not card users) - it exposes far more functionality than is comfortable (or even safe) for untrusted users. Systems intended for use by not-completely-trusted users should rather build on the REST and MQTT services.

  4. By default, uhppoted-httpd redirects to a setup page to create an admin user if none exists. This behaviour can (and should) be disabled by setting the httpd.security.no-setup config value to true in uhppoted.conf once an admin user has been created.

Release Notes

Current Release

v0.8.9 - 2024-09-06

  1. Added TCP/IP transport support.
  2. Fixed bug in authentication that allowed deleted user to login unless system had been restarted.
  3. On startup, redirects to 'setup' page to create an admin user if none exists.
  4. Added configurable admin role.
  5. Removed creation of admin user in daemonize.
  6. Added ADMIN role check to default grules rulesets.
  7. Added support for configurable default card start and end dates.
  8. Excluded cards with missing start or end dates from the ACL loaded to the controllers.
  9. Updated to Go 1.23.

Installation

Executables for all the supported operating systems are packaged in the releases:

The release tarballs contain the executables for all the operating systems - OS specific tarballs with all the uhppoted components can be found in uhpppoted releases.

Installation is straightforward - download the archive and extract it to a directory of your choice. To install uhppoted-httpd as a system service:

   cd <uhppoted directory>
   sudo uhppoted-httpd daemonize

uhppoted-httpd help will list the available commands and associated options (documented below).

The daemonize command will create all the necessary files for uhppoted-httpd if they do not exist already:

Docker

A public Docker image is published to ghcr.io.

The image is configured to use the /usr/local/etc/uhppoted/uhppoted.conf file for configuration information.

docker compose

A sample Docker compose configuration is provided in the docker/compose folder.

To run the example, download and extract the compose.zip scripts and supporting files into folder of your choice and then:

cd <compose folder>
docker compose up

And open URL http://localhost:8080 in your browser of choice.

The default image is configured for HTTP only but the example compose.yml file uses bind mounts to map the local folder to override the default configuration, HTML and system files to enable TLS and use the local filesystem for e.g. develoment.

Alternatively, copy the uhppoted.conf file, TLS keys and certificates and HTML to a Docker volume and remove the bind mounts from compose.yml. The expected folder structure is:

/
  usr
    local
      etc
        uhppoted
          - uhppoted.conf
          httpd
            - ca.cert
            - uhppoted.key
            - uhppoted.cert
            - acl.grl
            - auth.json
            grules
              - ...
            system
              - ...
            html
              - ...

docker run

To start a REST server using Docker run:

docker pull ghcr.io/uhppoted/httpd:latest
docker run --publish 8080:8080 --publish 8443:8443 --name httpd --mount source=uhppoted,target=/var/uhppoted --rm ghcr.io/uhppoted/httpd

And open URL http://localhost:8080 in your browser of choice.

docker build

For inclusion in a Dockerfile:

FROM ghcr.io/uhppoted/httpd:latest

Building from source

Required tools:

NOTES:

  1. apt install sass on Ubuntu installs ruby-sass which was marked obsolete in 2019. Please follow the installation instructions on the Sass homepage to install the current version._

  2. The make build uses eslint and eslint_config_standard. eslint_config_standard is a dev dependency and should be installed locally in the project:

    • Initial project setup: 
      git clone https://github.com/uhppoted/uhppoted-httpd.git
cd uhppoted-httpd
npm install eslint-config-standard
    • To build using the included Makefile: 
      cd uhppoted-httpd
make build
    • Without using make: 
      cd uhppoted-httpd
sass --no-source-map sass/themes/light:httpd/html/css/default
sass --no-source-map sass/themes/light:httpd/html/css/light
sass --no-source-map sass/themes/dark:httpd/html/css/dark
cp httpd/html/images/light/* httpd/html/images/default
go build -trimpath -o bin/ ./...

The above commands build the uhppoted-httpd executable to the bin directory.

External dependencies

Dependency Description
jwt/v3 JWT implementation
grule-rule-engine Rules engine
github.com/google/uuid UUID type implementation

uhppoted-httpd

Usage: uhppoted-httpd <command> <options>

Supported commands:

Defaults to run if the command it not provided i.e. uhppoted-httpd <options> is equivalent to uhppoted-httpd run <options>.

run

Runs the uhppoted-httpd HTTP server. Default command, intended for use as a system service that runs in the background.

Command line:

uhppoted-httpd [--debug] [--console] [--config <file>]

  --config      Sets the uhppoted.conf file to use for controller configurations. 
                Defaults to the communal uhppoted.conf file shared by all the uhppoted modules.
  --lockfile    (optional) Lockfile used to prevent running multiple copies of the _uhppoted-httpd_ service. 
                Defaults to _uhppoted-httpd.pid" (in the system _temp_ folder) if not provided.
  --console     Runs the HTTP server endpoint as a console application, logging events to the console.
  --debug       Displays verbose debugging information, in particular the communications with the 
                UHPPOTE controllers

daemonize

Registers uhppoted-httpd as a system service that will be started on system boot. The command creates the necessary system specific service configuration files and service manager entries. On Linux it defaults to using the uhppoted:uhppoted user:group - this can be changed with the --user option

Command line:

uhppoted-httpd daemonize [--user <user>]

undaemonize

Unregisters uhppoted-httpd as a system service, but does not delete any created log or configuration files.

Command line:

uhppoted-httpd undaemonize

config

Displays the current system configuration. Primarily intended as a convenience for scripts but can also be used to create a uhppoted.conf file by directing the output to a file (e.g. uhppoted-http config > /etc/uhppoted/uhppoted.conf)

Command line:

uhppoted-httpd config

Supporting files

uhppoted.conf

uhppoted.conf is the communal configuration file shared by all the uhppoted project modules and is (or will eventually be) documented in uhppoted. The daemonize command will create a uhppoted.conf file if one does not exist, or update the existing file with the default configuration.

The configuration for uhppoted-httpd is defined in the HTTPD section.

HTML files

By default, the static files for the user interface are served from a file system embedded in the application executable. For customisation, the static files can be relocated to an external folder, as described here:

auth.json

Coarse-grained authorisation for HTTP request is set by the entries in the auth.json file, which maps URLs and user roles to GET/POST rights. Detailed description of the file can be found here:

acl.grl

The acl.grl file implements rule based access for cards to supplement the relatively simple grid-based access control supported by the combination of card + groups + doors. The acl.grl file is documented in more detail here.

GRULES files

The grules files implement rule based fine-grained authorisation for view, create, update and delete operations on individual entities.. The grules files are documented in more detail here.

JSON files

The system data is (currently) stored as a set of JSON files, described (https://github.com/uhppoted/uhppoted-httpd/blob/master/documentation/db.md).

Notes

  1. uhppoted-http supports using OTP as an alternative to password based login. On that grounds that the most asked question so far has been "I've forgotten the admin password, how do I ..." it seems that once the system is setup and configured most users access it sufficiently infrequently for a secure password to be onerous. Login with OTP is a convenient alternative using something like e.g. Google Authenticator. Please note that is is less secure than using password-only access (of necessity, OTP secret keys are stored in plaintext on the server) so OTP should only be enabled if the server is secured.

  2. At login, uhppoted-http will automatically redirect to a setup page to create an admin user if one does not already exist (this supersedes the automatic creation of the default admin user by daemonize). Although enabled by default, this behaviour can (and should) be disabled by setting the httpd.security.no-setup config value to true in uhppoted.conf once an admin user has been created.

  3. The admin role is configurable by setting the httpd.security.admin.role value in uhppoted.conf (it defaults to admin). Changing the admin role requires the auth.json file to be updated with the new role.

  4. SECURITY : versions v0.8.8 and earlier have a bug in the authentication mechanism that allows a deleted user to log back in unless the system has been restarted. Fixed in the main branch and (as yet unreleased) version v0.8.9.